v1

latestOpenAPI 3.1.02026-07-2423390.9 KB

Start Journey

Start a new journey from backend server.

post/v2/start-journey

Request body

flow_idstring required

The flow_id to be used to apply your customised business rules on the submission.

reference_nostring

The reference number. (AKA userId)

Response

200

Example response

{
  "journey_summary": {
    "journey_id": "xxxxxxxxxxxxxxxx",
    "step_summaries": [
      {
        "result": {
          "status": "Not Submitted"
        }
      }
    ]
  }
}