Aml Check

post

https://api.idwise.com/checks/aml

Start a new journey from backend server.

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.
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.

Responses

Language

Credentials

Basic

base64

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json