v1

latestOpenAPI 3.1.02026-07-2423390.9 KB

Get Journey Summary

get/v2/summary/{JOURNEY_ID}

Path parameters

JOURNEY_IDstring required

The journey id to be retrieved

Query parameters

localestring

Two-character language code (e.g., en, ar) for response localization.

Response

200

journey_idstring
is_completedboolean

Example response

{
  "journey_id": "6568c0f12345678678ddb3c96d",
  "is_completed": true,
  "step_summaries": [
    {
      "definition": {
        "step_type": "Document",
        "step_title": "Photo ID"
      },
      "result": {
        "has_passed_rules": true,
        "is_concluded": true,
        "status": "Submitted"
      }
    }
  ],
  "result": {
    "interim_rule_assessment": "Failed",
    "interim_rule_details": {
      "same_subject": {
        "name": "Same Person",
        "result": "CouldNotApply"
      },
      "under_age": {
        "name": "Under Age",
        "result": "Failed"
      }
    }
  }
}