Skip to content

Blacklist databases

Access and query global databases to identify individuals or entities previously flagged for high-risk activities. Use this tool to cross-reference user data against known risk records

Operations

Persons

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

Example:"Josh Coffey"
first_namestring or null, (name), [ 2 .. 64 ] characters^[a-zA-Z ,.''-]{2,64}$

The first name of a person

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

The last name of a person

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

The middle name of a person

Example:"David"
dobstring or null, (date)

The date of birth of a person, formatted as “YYYY-MM-DD” according to ISO 8601

Example:"1976-02-21"
residence_countrystring or null, = 2 characters

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

Example:"GB"
genderstring or null

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

Enum:"M""F"
Example:"M"
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

Example:0.75
name_match_weightnumber, (float), decimal places <= 2, [ 0 .. 1 ]

Influence of a name match on the total match score

Example:0.7
dob_match_enabledboolean

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

Enum:truefalse
Example:true
dob_match_weightnumber, (float), decimal places <= 2, [ 0 .. 1 ]

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

Example:0.1
residence_country_match_enabledboolean

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

Enum:truefalse
Example:true
residence_country_match_weightnumber, (float), decimal places <= 2, [ 0 .. 1 ]

Influence of a residence country match on the total match score

Example:0.05
gender_match_enabledboolean

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

Enum:truefalse
Example:true
gender_match_weightnumber, (float), decimal places <= 2, [ 0 .. 1 ]

Influence of a gender match on the total match score

Example:0.05
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"
]
const resp = await fetch(
  `https://api.kycaid.com/bdb/persons`,
  {
    method: 'POST',
    headers: {
      'Content-Type': 'application/json',
      'API-Key': 'YOUR_API_KEY_HERE'
    },
    body: JSON.stringify({
      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']
    })
  }
);

const data = await resp.json();
console.log(data);

Responses

OK

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

Bodyapplication/json
dataobject
Response
{
  "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
      }
    ]
  }
}