Start Journey

post https://api.idwise.com/journey/v2/start-journey

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 Parameter	Description
flow_id	Type: `string` `required` The flow id.
reference_no	Type: `string` `required` The reference number.
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

Property	Description
full_name	Type: `string` `required` The full name of the applicant.
birth_date	Type: `string` `optional` The birth date of the applicant (ex: 2022-02-01)
sex	Type: `string` `optional` `male` or `female`

Request Response

Language

Credentials

Basic

base64

Click Try It! to start a request and see the response here!