Start Journey

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.


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.

applicant_details

  • Type:* 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

The Applicant Model represents the personal information submitted by the user during a journey. These fields are provided by the applicant (e.g., name, date of birth) and are securely captured by the platform.

Property

Description

full_name

  • Type:* string required The full name of the applicant.

birth_date

  • Type:* string optional The birth date of the applicant region where (ex: 2022-02-01)

sex

  • Type:* string optional male or female

address

  • Type:* string optional As printed on POA or as follows: Apartment Number, Building Name, Building Number, Street Name, Suburb, City, District, Postal Code, State, Country

nationality_code

  • Type:* string optional The applicant’s nationality, represented using the ISO 3166-1 alpha-3 standard (3-letter country code). For example: GBR (United Kingdom).

Request Response

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