Settings (2.0)

Overview

Terms of Service

Languages
Servers

https://api.kycaid.com/

Addresses

Addresses

Operations

Affiliated persons

Affiliated persons

Operations

Applicants

Applicants

Operations

Create an applicant

Request

Create a new applicant object in the system

Security
Your API key
Bodyapplication/json
One of:
typestringrequired

A type of an applicant object. PERSON type is used for KYC process, and COMPANY type is used for KYB process

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

A first name of an object

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

A middle name of an object

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

A last name of an object

dobstring or null(date)

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

genderstring or null

Gender of the individual. M indicates male, F indicates female

Enum"M""F"
pepboolean or null

A status of an object as a politically exposed person (PEP)

Enumtruefalse
residence_countrystring or null= 2 characters

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

nationalitystring or null= 2 characters

A nationality country of a person. A two-letter country code according to ISO 3166-2

phonestring or null[ 1 .. 15 ] characters

A phone number of an object

emailstring or null(email)[ 1 .. 254 ] characters

An email address of an object

telegram_usernamestring or null[ 1 .. 32 ] characters

A username of an object in Telegram instant messaging service

wallet_addressstring or null[ 1 .. 50 ] characters

A cryptocurrency wallet address of an object

external_applicant_idstring or null[ 0 .. 50 ] characters

A unique identifier of your user in your system

custom_field_1string or null[ 1 .. 2048 ] characters

A custom parameter to store additional data for an object by your managers

custom_field_2string or null[ 1 .. 2048 ] characters

A custom parameter to store additional data for an object by your managers

custom_field_3string or null[ 1 .. 2048 ] characters

A custom parameter to store additional data for an object by your managers

custom_field_4string or null[ 1 .. 2048 ] characters

A custom parameter to store additional data for an object by your managers

custom_field_5string or null[ 1 .. 2048 ] characters

A custom parameter to store additional data for an object by your managers

application/json
{
  "type": "PERSON",
  "first_name": "Josh",
  "middle_name": "David",
  "last_name": "Coffey",
  "dob": "1976-02-21",
  "gender": "M",
  "pep": false,
  "residence_country": "GB",
  "nationality": "GB",
  "phone": "441172345678",
  "email": "josh.coffey@example.com",
  "telegram_username": "JoshCoffey",
  "wallet_address": "0xb96FdB81a90Ee8aB5b69B2b5Eb7a401ab8c274D8",
  "external_applicant_id": "cb1eebbe-9945-4e64-8f60-c920f1e3e237",
  "custom_field_1": "This applicant was marked as suspicious by Mark L. at 11:40",
  "custom_field_2": "This applicant was marked as suspicious by Mark L. at 11:40",
  "custom_field_3": "This applicant was marked as suspicious by Mark L. at 11:40",
  "custom_field_4": "This applicant was marked as suspicious by Mark L. at 11:40",
  "custom_field_5": "This applicant was marked as suspicious by Mark L. at 11:40"
}

Responses

OK

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

Bodyapplication/json
applicant_idstring(uuid)= 36 characters

A unique identifier of an applicant, that is assigned by our system after an applicant object was created with a “Create an applicant” request

Response
application/json
{
  "applicant_id": "723f46ab04feb64f442946f2953a67eaecf7"
}

Get an applicant

Request

Get data on a created applicant

Security
Your API key
Path
applicant_idstring(uuid)= 36 charactersrequired

A unique identifier of an applicant, that is assigned by our system after an applicant object was created with a “Create an applicant” request

Example: 723f46ab04feb64f442946f2953a67eaecf7
No request payload

Responses

OK

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

Bodyapplication/json
One of:
applicant_idstring(uuid)= 36 characters

A unique identifier of an applicant, that is assigned by our system after an applicant object was created with a “Create an applicant” request

external_applicant_idstring or null[ 0 .. 50 ] characters

A unique identifier of your user in your system

typestring

A type of an applicant object. PERSON type is used for KYC process, and COMPANY type is used for KYB process

Value"PERSON"
created_atstring(date-time)

A date and time of creation of an object, set by our system

profile_statusstring or null

A status of an object profile verification, set by our system or our manager

Enum"valid""invalid"
profile_commentstring or null

A custom comment left by our manager for an object

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

A first name of an object

origin_first_namestring or null(name)[ 1 .. 64 ] characters

A first name of an object, set in a native language

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

A middle name of an object

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

A middle name of an object, set in a native language

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

A last name of an object

origin_last_namestring or null(name)[ 1 .. 64 ] characters

A last name of an entity, set in a native language

residence_countrystring or null= 2 characters

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

nationalitystring or null= 2 characters

A nationality country of a person. A two-letter country code according to ISO 3166-2

dobstring or null(date)

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

genderstring or null

Gender of the individual. M indicates male, F indicates female

Enum"M""F"
emailstring or null(email)[ 1 .. 254 ] characters

An email address of an object

phonestring or null[ 1 .. 15 ] characters

A phone number of an object

phone_statusstring or null

A status of an object phone verification, set by our system or our manager

Enum"valid""invalid"
wallet_addressstring or null[ 1 .. 50 ] characters

A cryptocurrency wallet address of an object

telegram_usernamestring or null[ 1 .. 32 ] characters

A username of an object in Telegram instant messaging service

pepboolean or null

A status of an object as a politically exposed person (PEP)

Enumtruefalse
custom_field_1string or null[ 1 .. 2048 ] characters

A custom parameter to store additional data for an object by your managers

custom_field_2string or null[ 1 .. 2048 ] characters

A custom parameter to store additional data for an object by your managers

custom_field_3string or null[ 1 .. 2048 ] characters

A custom parameter to store additional data for an object by your managers

custom_field_4string or null[ 1 .. 2048 ] characters

A custom parameter to store additional data for an object by your managers

custom_field_5string or null[ 1 .. 2048 ] characters

A custom parameter to store additional data for an object by your managers

decline_reasonsany
addressesany
documentsany
questionnairesany
verification_statusany
verifications_countany
Response
application/json
{
  "applicant_id": "723f46ab04feb64f442946f2953a67eaecf7",
  "external_applicant_id": "cb1eebbe-9945-4e64-8f60-c920f1e3e237",
  "type": "PERSON",
  "created_at": "2024-07-01 15:27:15",
  "profile_status": "valid",
  "profile_comment": "Suspicious activity",
  "first_name": "Josh",
  "origin_first_name": "Джош",
  "middle_name": "David",
  "origin_middle_name": "Conrad",
  "last_name": "Coffey",
  "origin_last_name": "Кофі",
  "residence_country": "GB",
  "nationality": "GB",
  "dob": "1976-02-21",
  "gender": "M",
  "email": "josh.coffey@example.com",
  "phone": "441172345678",
  "phone_status": "valid",
  "wallet_address": "0xb96FdB81a90Ee8aB5b69B2b5Eb7a401ab8c274D8",
  "telegram_username": "JoshCoffey",
  "pep": false,
  "custom_field_1": "This applicant was marked as suspicious by Mark L. at 11:40",
  "custom_field_2": "This applicant was marked as suspicious by Mark L. at 11:40",
  "custom_field_3": "This applicant was marked as suspicious by Mark L. at 11:40",
  "custom_field_4": "This applicant was marked as suspicious by Mark L. at 11:40",
  "custom_field_5": "This applicant was marked as suspicious by Mark L. at 11:40",
  "decline_reasons": null,
  "addresses": null,
  "documents": null,
  "questionnaires": null,
  "verification_status": null,
  "verifications_count": null
}

Update an applicant

Request

Update data of a created applicant

Security
Your API key
Path
applicant_idstring(uuid)= 36 charactersrequired

A unique identifier of an applicant, that is assigned by our system after an applicant object was created with a “Create an applicant” request

Example: 723f46ab04feb64f442946f2953a67eaecf7
No request payload

Responses

OK

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

Bodyapplication/json
object
Response
application/json
{}

Blacklist databases

Blacklist databases

Operations

Business activities

Business activities

Operations

Countries

Countries

Operations

Crypto

Crypto

Operations

Documents

Documents

Operations

Files

Files

Operations

Forms

Forms

Operations

Languages

Languages

Operations

Non-doc verification services

Non-doc verification services

Operations

Phone numbers

Phone numbers

Operations

QES

QES

Operations

Verifications

Verifications

Operations