CreateApplicantDto
Identifier of the applicant in your system. It must be unique: the request is rejected if an applicant with this identifier already exists. Use it later instead of the internal ID to get the applicant.
Name of the verification flow the applicant has to pass. The flow must exist in your company.
Phone number of the applicant. The request is rejected if the phone belongs to another applicant.
Email address of the applicant. The request is rejected if the email belongs to another applicant.
The language, in which the verification results should be displayed to applicants.
suppliedInfo object
Data about the applicant that you already have. It is compared with the data extracted from the applicant documents during the verification.
The first name of the applicant.
The last name of the applicant.
The middle name of the applicant.
An applicant gender (M or F).
Applicant date of birth (format YYYY-mm-dd, e.g. 2001-09-25).
The applicant birthplace.
Applicant country of birth.
Applicant state of birth.
Alpha-3 country code (e.g. DEU or GBR).
Alpha-3 country code of the applicant nationality.
addresses object[]
List of applicant addresses.
Alpha-3 country code.
Postal code.
Town or city name.
Street name.
State name.
Building name.
Flat or apartment number.
Building number.
{
"externalUserId": "string",
"flowName": "string",
"phone": "string",
"email": "string",
"lang": "string",
"suppliedInfo": {
"firstName": "string",
"lastName": "string",
"middleName": "string",
"gender": "string",
"dob": "string",
"placeOfBirth": "string",
"countryOfBirth": "string",
"stateOfBirth": "string",
"country": "string",
"nationality": "string",
"addresses": [
{
"country": "string",
"postCode": "string",
"town": "string",
"street": "string",
"state": "string",
"buildingName": "string",
"flatNumber": "string",
"buildingNumber": "string"
}
]
}
}