Skip to content

Create applicant

Request

Create a new applicant object in the system

Security
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"
Example:"PERSON"
first_namestring or null, (name), [ 2 .. 64 ] characters^[a-zA-Z ,.''-]{2,64}$

The first name of a person

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

The middle name of a person

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

The last name of a person

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

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

Example:"1976-02-21"
genderstring or null

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

Enum:"M""F"
Example:"M"
pepboolean or null

The status of a person as a politically exposed person (PEP)

Enum:truefalse
Example:false
residence_countrystring or null, = 2 characters

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

Example:"GB"
nationalitystring or null, = 2 characters

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

Example:"GB"
phonestring or null, [ 1 .. 15 ] characters

The phone number of a person or a company

Example:"441172345678"
emailstring or null, (email), [ 1 .. 254 ] characters

The email address of a person or a company

Example:"josh.coffey@example.com"
telegram_usernamestring or null, [ 1 .. 32 ] characters

A username of an object in Telegram instant messaging service

Example:"JoshCoffey"
wallet_addressstring or null, [ 1 .. 50 ] characters

A cryptocurrency wallet address of an object

Example:"GQzMeEMwAR44ugoNCifTb5NdRKos0GduDUPeNh6AgV46"
external_applicant_idstring or null, [ 0 .. 50 ] characters

A unique identifier of your user in your system

Example:"8ba166fd-e9ba-49c6-b91a-fdbf0f63f939"
custom_field_1string or null, [ 1 .. 2048 ] characters

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

Example:"This applicant was marked as suspicious by Mark L. at 11:40"
custom_field_2string or null, [ 1 .. 2048 ] characters

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

Example:"This applicant was marked as suspicious by Mark L. at 11:40"
custom_field_3string or null, [ 1 .. 2048 ] characters

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

Example:"This applicant was marked as suspicious by Mark L. at 11:40"
custom_field_4string or null, [ 1 .. 2048 ] characters

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

Example:"This applicant was marked as suspicious by Mark L. at 11:40"
custom_field_5string or null, [ 1 .. 2048 ] characters

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

Example:"This applicant was marked as suspicious by Mark L. at 11:40"
{
  "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": "GQzMeEMwAR44ugoNCifTb5NdRKos0GduDUPeNh6AgV46",
  "external_applicant_id": "8ba166fd-e9ba-49c6-b91a-fdbf0f63f939",
  "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, = 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

Example:"27c5caea93ee4656881ef9a30fadd21a3768"
Response
{
  "applicant_id": "27c5caea93ee4656881ef9a30fadd21a3768"
}