Skip to content

Overview

Terms of Service

Languages
Servers

https://api.kycaid.com/

Blacklist databases

Operations

Persons

Request

Retrieve information on persons 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
Your API key
Bodyapplication/json
One of:
full_namestring or null(name)[ 1 .. 100 ] characters^[a-zA-Z ,.''-]{1,100}$required

A full name of an object, which consists of a first name and a last name

first_namestring or null(name)[ 1 .. 64 ] characters^[a-zA-Z ,.''-]{1,64}$

A first name of an object

last_namestring or null(name)[ 1 .. 64 ] characters^[a-zA-Z ,.''-]{1,64}$

A last name of an object

middle_namestring or null(name)[ 1 .. 64 ] characters^[a-zA-Z ,.''-]{1,64}$

A middle name of an object

dobstring or null(date)

The date of birth of a person, formatted according to ISO 8601

residence_countrystring or null= 2 characters

A residence country of an object. A two-letter country code according to ISO 3166-2

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)
  • SELF_RESTICTED: Databases of persons asked for self-exclusion
  • WANTED: Databases of persons being searched for by the police
  • EXPIRED: Databases of stolen or lost documents
Items Enum"INTERNAL""SANCTIONS""PEP""SELF_RESTICTED""WANTED""EXPIRED"
application/json
{
  "full_name": "Josh Coffey",
  "first_name": "Josh",
  "last_name": "Coffey",
  "middle_name": "David",
  "dob": "1976-02-21",
  "residence_country": "GB",
  "bdb_types": [
    "SANCTIONS"
  ]
}

Responses

OK

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

Bodyapplication/json
dataArray of objects
Response
application/json
{
  "data": [
    {
      "full_name": "Josh Coffey",
      "origin_full_name": "Джош Кофі",
      "first_name": "Josh",
      "origin_first_name": "Джош",
      "last_name": "Coffey",
      "origin_last_name": "Кофі",
      "middle_name": "David",
      "origin_middle_name": "Conrad",
      "residence_country": "GB",
      "dob": "1976-02-21",
      "gender": "M",
      "description": "Reciprocal - 2010-04-30",
      "bdb_name": "Open Sanctions Default",
      "bdb_type": [
        "SANCTIONS"
      ],
      "accuracy": 75
    }
  ]
}

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
Your API key
Bodyapplication/json
document_numberstring[ 2 .. 32 ] charactersrequired

A number of a document to check with blacklist databases

document_typestring

A type of a document

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

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

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)
  • SELF_RESTICTED: Databases of persons asked for self-exclusion
  • WANTED: Databases of persons being searched for by the police
  • EXPIRED: Databases of stolen or lost documents
Items Enum"INTERNAL""SANCTIONS""PEP""SELF_RESTICTED""WANTED""EXPIRED"
application/json
{
  "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
application/json
{
  "data": [
    {
      "document_number": "920927302325",
      "document_type": "PASSPORT",
      "document_country": "GB",
      "description": "Reciprocal - 2010-04-30",
      "bdb_name": "Open Sanctions Default",
      "bdb_type": [
        "SANCTIONS"
      ]
    }
  ]
}

Tax ID numbers

Request

Retrieve information on tax ID numbers 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
Your API key
Bodyapplication/json
tax_id_numberstring[ 2 .. 32 ] charactersrequired

A tax identification number

tax_id_countrystring or null= 2 characters

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

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)
  • SELF_RESTICTED: Databases of persons asked for self-exclusion
  • WANTED: Databases of persons being searched for by the police
  • EXPIRED: Databases of stolen or lost documents
Items Enum"INTERNAL""SANCTIONS""PEP""SELF_RESTICTED""WANTED""EXPIRED"
application/json
{
  "tax_id_number": "1129821775",
  "tax_id_country": "GB",
  "bdb_types": [
    "SANCTIONS"
  ]
}

Responses

OK

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

Bodyapplication/json
One of:
dataArray of objects
Response
application/json
{
  "data": [
    {
      "full_name": "Josh Coffey",
      "origin_full_name": "Джош Кофі",
      "first_name": "Josh",
      "origin_first_name": "Джош",
      "last_name": "Coffey",
      "origin_last_name": "Кофі",
      "middle_name": "David",
      "origin_middle_name": "Conrad",
      "residence_country": "GB",
      "dob": "1976-02-21",
      "gender": "M",
      "description": "Reciprocal - 2010-04-30",
      "bdb_name": "Open Sanctions Default",
      "bdb_type": [
        "SANCTIONS"
      ],
      "accuracy": 75
    }
  ]
}

Crypto

Operations

Phone numbers

Operations

QES

Operations