{
  "opencollection": "1.0.0",
  "info": {
    "name": "Onfido Documents API",
    "version": "v3.6"
  },
  "request": {
    "auth": {
      "type": "apikey",
      "key": "Authorization",
      "value": "{{Authorization}}",
      "placement": "header"
    }
  },
  "items": [
    {
      "info": {
        "name": "Documents",
        "type": "folder"
      },
      "items": [
        {
          "info": {
            "name": "List documents",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.{region}.onfido.com/v3.6/documents",
            "params": [
              {
                "name": "applicant_id",
                "value": "",
                "type": "query"
              }
            ]
          },
          "docs": "All documents belonging to an applicant can be listed from this endpoint"
        },
        {
          "info": {
            "name": "Upload a document",
            "type": "http"
          },
          "http": {
            "method": "POST",
            "url": "https://api.{region}.onfido.com/v3.6/documents",
            "body": {
              "type": "multipart-form",
              "data": []
            }
          },
          "docs": "Documents are uploaded using this endpoint. Along with the file upload the relevant document type must be specified. Documents must be uploaded as a multipart form. The valid file types are: jpg, png and pdf. The file size must be between 2KB and 3MB.\n"
        },
        {
          "info": {
            "name": "Retrieve document",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.{region}.onfido.com/v3.6/documents/:document_id",
            "params": [
              {
                "name": "document_id",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "A single document can be retrieved by calling this endpoint with the document's unique identifier.\n"
        },
        {
          "info": {
            "name": "Download document",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.{region}.onfido.com/v3.6/documents/:document_id/download",
            "params": [
              {
                "name": "document_id",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "Downloads specific documents belonging to an applicant. If successful, the response will be the binary data representing the image.\n"
        },
        {
          "info": {
            "name": "Download document video",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.{region}.onfido.com/v3.6/documents/:document_id/video/download",
            "params": [
              {
                "name": "document_id",
                "value": "",
                "type": "path"
              }
            ]
          },
          "docs": "Downloads a document video. If successful, the response will be the binary data representing the video.\n"
        },
        {
          "info": {
            "name": "Retrieves the signed document or application form",
            "type": "http"
          },
          "http": {
            "method": "GET",
            "url": "https://api.{region}.onfido.com/v3.6/qualified_electronic_signature/documents",
            "params": [
              {
                "name": "workflow_run_id",
                "value": "",
                "type": "query",
                "description": "The unique identifier of the Workflow Run for which you want to retrieve the signed document."
              },
              {
                "name": "file_id",
                "value": "",
                "type": "query",
                "description": "The unique identifier of the file which you want to retrieve."
              }
            ]
          },
          "docs": "Retrieves the signed document or application form depending on the file_id provided.\n"
        }
      ]
    }
  ],
  "bundled": true
}