post https://api.idwise.com/checks/aml
Start a new journey from backend server.
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.
- EU (Default): https://api.idwise.com/
- UAE: https://api-uae.idwise.com/
- Qatar: https://api-qat.idwise.com/
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 requiredThe flow id. |
| reference_no | Type: string requiredThe reference number. |
| entity_details | Type: object optionalThe applicant object, only full name is mandatory, birth year and sex are optional parametersCheck the applicantDetails request model table for more information |
applicant_details request model
| Property | Description |
|---|---|
| full_name | Type: string requiredThe full name of the applicant. |
| birth_year | Type: string optionalThe birth year of the applicant (ex: 2022) |
| sex | Type: string optionalmale or female |
Request Response
| Output Parameter | Description |
|---|---|
| success | Type: boolThe success result. |
| check_id | Type: stringThe check_id of this check used to retrieve the result. |