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 ParameterDescription
flow_idType: string required
The flow id.
reference_noType: string required
The reference number.
entity_detailsType: 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

PropertyDescription
full_nameType: string required
The full name of the applicant.
birth_yearType: string optional
The birth year of the applicant (ex: 2022)
sexType: string optional
male or female

Request Response

Output ParameterDescription
successType: bool
The success result.
check_idType: string
The check_id of this check used to retrieve the result.
Language
Authorization
Basic
base64
:
Click Try It! to start a request and see the response here!