Skip to content

Documents

Request

Retrieve information on documents from the Kycaid blacklist databases to check for compliance with laws and regulations. Each response may have several objects, with one object per a blacklist

Security
API-Key
Bodyapplication/json
document_numberstring, [ 2 .. 32 ] charactersrequired

A number of a document to check with blacklist databases

Example:"920927302325"
document_typestring

A type of a document

Enum:"PASSPORT""DOMESTIC_PASSPORT""GOVERNMENT_ID""DRIVERS_LICENSE""FOREIGN_CITIZEN_PASSPORT""PERMANENT_RESIDENCE_PERMIT""REFUGEE_CARD"
Example:"PASSPORT"
document_countrystring or null, = 2 characters

An issuing country of a document. A two-letter country code according to ISO 3166-2

Example:"GB"
bdb_typesArray of strings

A type of blacklist databases to make a check

  • SANCTIONS: Global and local sanctions databases
  • PEP: Databases of politically exposed persons (PEP)
  • WANTED: Databases of persons being searched for by the police
  • EXPIRED: Databases of stolen or lost documents
Items Enum:"INTERNAL""SANCTIONS""PEP""WANTED""EXPIRED"
Example:
[
  "SANCTIONS"
]
{
  "document_number": "920927302325",
  "document_type": "PASSPORT",
  "document_country": "GB",
  "bdb_types": [
    "SANCTIONS"
  ]
}

Responses

OK

The request was successful, and our system returned an expected response.

Bodyapplication/json
dataArray of objects
Response
{
  "data": [
    {
      "document_number": "920927302325",
      "document_type": "PASSPORT",
      "document_country": "GB",
      "description": "Reciprocal - 2010-04-30",
      "bdb_name": "Open Sanctions Default",
      "bdb_type": [
        "SANCTIONS"
      ]
    }
  ]
}