Usage

The Get Journey Summary API is designed to provide status updates on a specified journey. This API is intended for periodic checks on the journey's progress and current state.

🚧
Rate Limiting

The API should be called with an interval of at least 2 seconds.

Frequent calls beyond the advised interval may lead to temporary blocking of the API access as a measure to prevent system overload.

Authentication

Please refer to the API Credentials and Authentication page for more detailed information

API Response Description

The response has the following structure.

{
    "journey_id": "6568c0f**********db3c96d",
    "is_completed": true,
    "step_summaries": [StepSummary],
    "result": InterimJourneyResult
}

Property	Description
journey_id	Type*: `string` A unique identifier for the user journey.
is_completed	Type*: `bool` A boolean attribute that signifies whether the journey has been finished. Once a journey is marked as complete, it cannot be modified.
step_summaries	Type*:`list[object]` An array of objects, each representing a step in the journey. The provides information about each step and its status.
result	Type*:`object` Holds the overarching outcomes of the journey.

Step Summary:

Each object in the step_summaries array has:

{
  "definition": {
    "step_id": 0,
    "step_type": "Document",
    "step_title": "Photo ID"
  },
  "result": {
    "has_passed_rules": true,
    "is_concluded":true,
    "status": "Submitted",
    "error_user_feedback_code": null,
    "error_user_feedback_title": "",
    "error_user_feedback_details": ""
  }
}

Property	Description
definition	Type*: `object` An object that describes the step. It contains:\ `step_id`:`string` An identifier for the step within the journey. `step_type`:`string` The step's type, which can be either `Document` or `Selfie`, indicating the kind of submission required from the user at this stage. `step_title`: `string` the step title.
result	Type*: `object` An object that contains the current result of the step. It contains:\ `has_passed_rules`: `bool` indicates whether the user has successfully passed the validation rules for the step or not. `is_concluded`: `bool` – Indicates whether the step has been completed, either by passing all rules or by the user exhausting all retry attempts. `status`:`string` shows the status of the step. This can be one of `Not Submitted`, `In Progress` or `Submitted`. `error_user_feedback_code`: `string`, `nullable` A code that can be used to indicate the error. All the error feedback codes can be found here. `error_user_feedback_title`: `string`, `nullable` A title for the error message directed at the user, providing feedback in case an error occurs during the step. `error_user_feedback_details`: `string`, `nullable` details for the error message directed at the user, providing feedback in case an error occurs during the step.

Property

Description

definition

*Type**: object
An object that describes the step. It contains:\
step_id:string An identifier for the step within the journey.
step_type:string The step's type, which can be either Document or Selfie, indicating the kind of submission required from the user at this stage.
step_title: string the step title.

result

*Type**: object
An object that contains the current result of the step. It contains:\
has_passed_rules: bool indicates whether the user has successfully passed the validation rules for the step or not.
is_concluded: bool – Indicates whether the step has been completed, either by passing all rules or by the user exhausting all retry attempts.
- status:string shows the status of the step. This can be one of Not Submitted, In Progress or Submitted.
- error_user_feedback_code: string, nullable A code that can be used to indicate the error. All the error feedback codes can be found here.
- error_user_feedback_title: string, nullable A title for the error message directed at the user, providing feedback in case an error occurs during the step.
- error_user_feedback_details: string, nullable details for the error message directed at the user, providing feedback in case an error occurs during the step.

Interim Journey Result

Holds the overarching outcomes of the journey.

{
  "interim_rule_assessment": "Failed",
  "interim_rule_details": {
    "same_subject": {
      "name": "Same Person",
      "result": "Passed"
    },
     "under_age": {
       "name": "Under Age",
        "result": "Failed"
     },
    "no_duplicate_applicant":{
      "name": "Unique Applicant",
      "result": "Passed"
    }
  }

Property	Description
interim_rule_assessment	Type*: `string` Represents the current status of the journey rules executed up to this point, which can either, `Failed` or `Passed`.
interim_rule_details	Type: `object` Offers detailed insights into journey-level rules executed up to this point. each element of the `interim_rule_details` is a key and value pair:\ The key is a programmatic name for the rule. All the available rule keys can be found here . The value is an object with the following fields.: - name: `string` the rule name - result*: `string` the rule results which can have one of the following values `Failed`, `Passed` or `CouldNotApply`

Property

Description

interim_rule_assessment

*Type**: string
Represents the current status of the journey rules executed up to this point, which can either, Failed or Passed.

interim_rule_details

*Type**: object
Offers detailed insights into journey-level rules executed up to this point. each element of the interim_rule_details is a key and value pair:\
The key is a programmatic name for the rule. All the available rule keys can be found here .
The value is an object with the following fields.:
- name: string the rule name
- result: string the rule results which can have one of the following values Failed, Passed or CouldNotApply

Rule Keys:

This table contains all the rule keys that exists in the interim_rule_details

Rule Key	Description
`same_subject`	The same person rule key.
`under_age`	The under age rule key.
`no_duplicate_applicant`	No duplicate applicant rule key