v1

latestOpenAPI 3.0.3MIT2026-07-267013.8 KB

Start journey

Start a customer verification journey using a journey ID. You can also prefill customer data. For more details, see the start journey guide.

post/journey/start

Request body

resourceIdstring required

Unique identifier for the journey. Append '@latest' to use the most recent version.

contextobject

Prefilled identity data for the journey.

Example request

{
  "resourceId": "2ec919f77eb9858f16a9c102913f68c2ede2e31952d3e2b8f5ca7028d5c480bc@latest",
  "context": {
    "subject": {
      "identity": {
        "firstName": "John",
        "lastName": "Doe",
        "dateOfBirth": "1990-01-01",
        "emails": [
          {
            "type": "home",
            "email": "john.doe@example.com"
          }
        ]
      },
      "documents": [],
      "biometrics": []
    }
  }
}

Response

Journey started successfully.

instanceIdstring

Unique identifier for the active journey instance.