Skip to content

Create verification

Request

Content migration in progress

Please refer to the legacy documentation for this article

Security
API-Key
Bodyapplication/json
applicant_idstring, = 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:"27c5caea93ee4656881ef9a30fadd21a3768"
form_idstring or null, = 36 charactersrequired

A unique identifier of a form, assigned by our system after it is created in the Dashboard

Example:"27c5caea93ee4656881ef9a30fadd21a3768"
language_codestring, = 2 characters

A language of an object. A two-letter language code according to ISO 639-1

Example:"EN"
{
  "applicant_id": "27c5caea93ee4656881ef9a30fadd21a3768",
  "form_id": "27c5caea93ee4656881ef9a30fadd21a3768",
  "language_code": "EN"
}

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