{
  "opencollection": "1.0.0",
  "info": {
    "name": "Credentially Public Compliance-packages Documents API",
    "version": "2.0.0"
  },
  "items": [
    {
      "info": {
        "name": "Documents",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "Get Profile Documents",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://app.credentially.io/gateway/api/documents/:profileId",
            "headers": [
              {
                "name": "X-API-Version",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "profileId",
                "value": "",
                "type": "path"
              }
            ],
            "auth": {
              "type": "bearer",
              "token": "{{bearerToken}}"
            }
          },
          "docs": "Fetches documents for a profile, enriched with extra OCR fields.\n\n**Rate Limit:** `get-documents` (100 req / 1s)"
        },
        {
          "info": {
            "name": "Upload Profile Document",
            "type": "http"
          },
          "http": {
            "method": "PUT",
            "url": "https://app.credentially.io/gateway/api/documents/:profileId",
            "headers": [
              {
                "name": "X-API-Version",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "profileId",
                "value": "",
                "type": "path"
              }
            ],
            "body": {
              "type": "multipart-form",
              "data": [
                {
                  "name": "data",
                  "type": "text",
                  "value": ""
                },
                {
                  "name": "file",
                  "type": "text",
                  "value": ""
                }
              ]
            },
            "auth": {
              "type": "bearer",
              "token": "{{bearerToken}}"
            }
          },
          "docs": "Uploads a document for a specific profile and triggers processing.\n\n**Rate Limit:** `get-documents` (100 req / 1s)"
        },
        {
          "info": {
            "name": "Reject document of file.",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "https://app.credentially.io/gateway/api/documents/reject",
            "headers": [
              {
                "name": "X-API-Version",
                "value": ""
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "bearer",
              "token": "{{bearerToken}}"
            }
          },
          "docs": "Decline specific document and file.\n\n**Rate Limit:** `reject-document` (5 req / 1s)"
        },
        {
          "info": {
            "name": "Approve document of file.",
            "type": "http"
          },
          "http": {
            "method": "PATCH",
            "url": "https://app.credentially.io/gateway/api/documents/approve",
            "headers": [
              {
                "name": "X-API-Version",
                "value": ""
              }
            ],
            "body": {
              "type": "json",
              "data": "{}"
            },
            "auth": {
              "type": "bearer",
              "token": "{{bearerToken}}"
            }
          },
          "docs": "Approve specific document and file.\n\n**Rate Limit:** `approve-document` (5 req / 1s)"
        },
        {
          "info": {
            "name": "Download file by its id",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://app.credentially.io/gateway/api/documents/download",
            "headers": [
              {
                "name": "X-API-Version",
                "value": ""
              }
            ],
            "params": [
              {
                "name": "fileId",
                "value": "",
                "type": "query"
              }
            ],
            "auth": {
              "type": "bearer",
              "token": "{{bearerToken}}"
            }
          },
          "docs": "Download file by its id.\n\n**Rate Limit:** `download-file` (5 req / 1s)"
        },
        {
          "info": {
            "name": "Get Organisation Document Types",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://app.credentially.io/gateway/api/documents/document-types",
            "headers": [
              {
                "name": "X-API-Version",
                "value": ""
              }
            ],
            "auth": {
              "type": "bearer",
              "token": "{{bearerToken}}"
            }
          },
          "docs": "Fetches document types for an organisation.\n\n**Rate Limit:** `get-document-types` (100 req / 1s)"
        }
      ]
    }
  ],
  "bundled": true
}