Base URL by Region

The base URL you should use depends on the region where your services are hosted. Below are the available URLs for each region. By default, the EU region URL is used.

Authentication

Please refer to the API Credentials and Authentication page for more detailed information

Request Model

The request is a POST request with the following parameters sent in the body

Input Parameter	Description
flow_id	Type:* `string` `required` The flow id.
reference_no	Type:* `string` `required` The reference number. This parameter accepts only alphanumeric characters (A–Z, a–z, 0–9) and the following special characters: [- _ / \ , . + @]. Leading and trailing spaces will be automatically removed.
entity_details	Type:* `object` `optional` The applicant object, only `full name` is mandatory, `birth year` and `sex` are optional parameters Check the applicantDetails request model table for more information

applicant_details request model

Property	Description
full_name	Type:* `string` `required` The full name of the applicant.
birth_year	Type:* `string` `optional` The birth year of the applicant (ex: 2022)
sex	Type:* `string` `optional` `male` or `female`

Request Response

Output Parameter	Description
success	Type:* `bool` The success result.
check_id	Type:* `string` The check_id of this check used to retrieve the result.

Base URL by Region

Authentication

Request Model

applicant_details request model

Request Response

200200

400400

401401

403403

404404

429429

500500