Skip to content

Overview (1.0)

Overview

Terms of Service

Languages
Servers

https://api.kycaid.com/

Blacklist databases

Blacklist databases

Operations

Persons v1

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)[ 2 .. 100 ] characters^[a-zA-Z ,.''-]{1,100}$required

The full name of a person, which includes a first and last name

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

The first name of a person

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

The last name of a person

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

The middle name of a person

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
    }
  ]
}

Persons v2

Request

Retrieve information on persons from the Kycaid blacklist databases using fuzzy search 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)[ 2 .. 100 ] characters^[a-zA-Z ,.''-]{1,100}$required

The full name of a person, which includes a first and last name

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

The first name of a person

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

The last name of a person

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

The middle name of a person

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

genderstring or null

The gender of a person. M indicates male; F indicates female

Enum"M""F"
name_match_thresholdnumber(float)decimal places <= 2[ 0 .. 1 ]

The minimum similarity score required to include a name in the search results. A higher value returns fewer, more exact matches, and a lower value returns more results with less similarity

name_match_weightnumber(float)decimal places <= 2[ 0 .. 1 ]

Influence of a name match on the total match score

dob_match_enabledboolean

Enable or disable inclusion of a date of birth in the total match score

Enumtruefalse
dob_match_weightnumber(float)decimal places <= 2[ 0 .. 1 ]

Influence of a date of birth match on the total match score

residence_country_match_enabledboolean

Enable or disable inclusion of a residence country match in the total match score

Enumtruefalse
residence_country_match_weightnumber(float)decimal places <= 2[ 0 .. 1 ]

Influence of a residence country match on the total match score

gender_match_enabledboolean

Enable or disable inclusion of a gender match in the total match score

Enumtruefalse
gender_match_weightnumber(float)decimal places <= 2[ 0 .. 1 ]

Influence of a gender match on the total match score

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",
  "gender": "M",
  "name_match_threshold": 0.75,
  "name_match_weight": 0.7,
  "dob_match_enabled": true,
  "dob_match_weight": 0.1,
  "residence_country_match_enabled": true,
  "residence_country_match_weight": 0.05,
  "gender_match_enabled": true,
  "gender_match_weight": 0.05,
  "bdb_types": [
    "SANCTIONS"
  ]
}

Responses

OK

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

Bodyapplication/json
dataobject
Response
application/json
{
  "data": {
    "parameters": {
      "name_match_threshold": 0.75,
      "name_match_weight": 0.7,
      "dob_match_enabled": true,
      "dob_match_weight": 0.1,
      "residence_country_match_enabled": true,
      "residence_country_match_weight": 0.05,
      "gender_match_enabled": true,
      "gender_match_weight": 0.05
    },
    "result": [
      {
        "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",
        "dob": "1976-02-21",
        "residence_country": "GB",
        "gender": "M",
        "description": "Reciprocal - 2010-04-30",
        "bdb_name": "Open Sanctions Default",
        "aliases": [
          {}
        ],
        "addresses": [
          {}
        ],
        "name_match_score": 0.8,
        "total_match_score": 0.86
      }
    ]
  }
}

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
    }
  ]
}

Adverse media check

Adverse media check

Operations

Crypto

Crypto

Operations

Phone numbers

Phone numbers

Operations

QES

QES

Operations