Start a new journey from backend server.

Recipes
API-Based Journey Processing
Open Recipe

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.
applicant_detailsType: object optional
(optional) only for AML journeys.
The applicant object, only full name is mandatory, birth date 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_dateType: string optional
The birth date of the applicant (ex: 2022-02-01)
sexType: string optional
male or female

Request Response

Language
Authorization
Basic
base64
:
Click Try It! to start a request and see the response here!