# Documents

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

Endpoint: POST /bdb/documents
Security: Your API key

## Request fields (application/json):

  - `document_number` (string, required)
    A number of a document to check with blacklist databases

  - `document_type` (string)
    A type of a document
    Enum: "PASSPORT", "DOMESTIC_PASSPORT", "GOVERNMENT_ID", "DRIVERS_LICENSE", "FOREIGN_CITIZEN_PASSPORT", "PERMANENT_RESIDENCE_PERMIT", "REFUGEE_CARD"

  - `document_country` (string,null)
    An issuing country of a document. A two-letter country code according to ISO 3166-2

  - `bdb_types` (array)
    A type of blacklist databases to make a check
* : Global and local sanctions
databases
* : Databases of politically exposed persons (PEP)
* : Databases of persons asked for self-exclusion
* : Databases of persons being searched for by the police
* : Databases of stolen or lost documents
    Enum: "INTERNAL", "SANCTIONS", "PEP", "SELF_RESTICTED", "WANTED", "EXPIRED"

## Response 200 fields (application/json):

  - `data` (array)

  - `data.document_number` (string)
    A number of a document to check with blacklist databases

  - `data.document_type` (string)
    A type of a document
    Enum: "PASSPORT", "DOMESTIC_PASSPORT", "GOVERNMENT_ID", "DRIVERS_LICENSE", "FOREIGN_CITIZEN_PASSPORT", "PERMANENT_RESIDENCE_PERMIT", "REFUGEE_CARD"

  - `data.document_country` (string,null)
    An issuing country of a document. A two-letter country code according to ISO 3166-2

  - `data.description` (string,null)
    A detailed description of a status in blacklist databases

  - `data.bdb_name` (string,null)
    A name of a blacklist database

  - `data.bdb_type` (array)
    A type of blacklist databases to make a check
* : Global and local sanctions
databases
* : Databases of politically exposed persons (PEP)
* : Databases of persons asked for self-exclusion
* : Databases of persons being searched for by the police
* : Databases of stolen or lost documents
    Enum: "INTERNAL", "SANCTIONS", "PEP", "SELF_RESTICTED", "WANTED", "EXPIRED"

## Response 400 fields (application/json):

  - `type` (string)
    Example: "bad_request"

  - `errors` (array)

## Response 422 fields (application/json):

  - `errors` (array)

  - `errors.parameter` (string)
    Example: "document_number"

  - `errors.message` (string)
    Example: "document_number must have from 2 to 32 characters and only letters and numbers"

## Response 500 fields (application/json):

  - `type` (string)
    Example: "internal_server"

  - `errors` (array)