{
  "opencollection": "1.0.0",
  "info": {
    "name": "Tradeverifyd Documents Verifiable Credentials API",
    "version": "0.2.0"
  },
  "request": {
    "auth": {
      "type": "apikey",
      "key": "ocp-apim-subscription-key",
      "value": "{{ocp-apim-subscription-key}}",
      "placement": "header"
    }
  },
  "items": [
    {
      "info": {
        "name": "Verifiable Credentials",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Issue credential",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.tradeverifyd.com/v1/credentials/issue",
            "body": {
              "type": "json",
              "data": "{}"
            }
          },
          "docs": "Issues W3C Traceability compliant verifiable credentials for trade documents. IntentToImport (ITI) credentials are restricted to one per shipment to prevent duplicates. All credentials are encoded in Base64 and stored with the associated shipment."
        },
        {
          "info": {
            "name": "List credentials",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.tradeverifyd.com/v1/credentials/list"
          },
          "docs": "List verifiable credentials for the organization."
        },
        {
          "info": {
            "name": "List credentials by shipment",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.tradeverifyd.com/v1/credentials/list/shipment/:shipment_id",
            "params": [
              {
                "name": "shipment_id",
                "value": "",
                "type": "path",
                "description": "The shipment ID to filter credentials by"
              }
            ]
          },
          "docs": "List verifiable credentials for a specific shipment."
        },
        {
          "info": {
            "name": "Get credential details",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.tradeverifyd.com/v1/credentials/details/:verifiable_credential_id",
            "params": [
              {
                "name": "verifiable_credential_id",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "Get detailed information about a specific verifiable credential for the organization"
        },
        {
          "info": {
            "name": "Get credential formatted as PDF",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.tradeverifyd.com/v1/credentials/details/:verifiable_credential_id/pdf",
            "params": [
              {
                "name": "verifiable_credential_id",
                "value": "",
                "type": "path",
                "description": "The ID of the verifiable credential to retrieve."
              }
            ]
          },
          "docs": "Formatted PDF of a verifiable credential"
        },
        {
          "info": {
            "name": "Validate credential",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.tradeverifyd.com/v1/credentials/validation/:verifiable_credential_id",
            "params": [
              {
                "name": "verifiable_credential_id",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "Verifies the digital siganture, validates the credential schema, checks the credential status and stores the result."
        },
        {
          "info": {
            "name": "Validate document",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.tradeverifyd.com/v1/credentials/document/validation/:document_path",
            "params": [
              {
                "name": "document_path",
                "value": "",
                "type": "path",
                "description": "The path to the document to validate"
              }
            ]
          },
          "docs": "Verifies the digital signature, validates the credential schema, checks the credential status and stores the result."
        },
        {
          "info": {
            "name": "Get schemas",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.tradeverifyd.com/v1/credentials/schemas"
          },
          "docs": "Get all schemas"
        },
        {
          "info": {
            "name": "Get schema by name",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.tradeverifyd.com/v1/credentials/schemas/:schema_name",
            "params": [
              {
                "name": "schema_name",
                "value": "",
                "type": "path",
                "description": "The name of the schema to retrieve"
              }
            ]
          },
          "docs": "Get schema by name"
        }
      ]
    }
  ],
  "bundled": true
}