Supported Documents

Retrieve all supported document types and country combinations for various checks.

This endpoint allows you to retrieve a list of all documents supported by our Document Checks service.

The lists are updated periodically, so the returned values are expected to change.

URL

GET https://api.complycube.com/v1/static/supportedDocuments

Retrieves all supported document types and country combinations.

Headers

Name	Type	Description
Authorization*	string	The API live or test key.

Example request

cURL

curl -X GET https://api.complycube.com/v1/static/supportedDocuments \
     -H 'Authorization: <YOUR_API_KEY>' 

Node.js

const { ComplyCube } = require("@complycube/api");

const complycube = new ComplyCube({ apiKey: "<YOUR_API_KEY>" });

const screeningLists = await complycube.static.listSupportedDocuments();

Example response

Success (200)

{
  "document_check": {
    "passport": {
      "AE": {
        "sides": 1
      },
      "AD": {
        "sides": 1
      },
      "AE": {
        "sides": 1
      },
      "AF": {
        "sides": 1
      }
    }
    ...
  }
}