Getting the Journey Status

The journey summary contains the status of the journey and its steps. Which steps are concluded and no longer should be started and which steps passed or failed the checks.

You can enquire about the journey status at any time by calling getJourneySummary method as follows:

IDWiseDynamic.getJourneySummary(callback: { summary, error in

})

IDWiseDynamic.getJourneySummary() { journeySummary, error ->
  // journeySummary contains the status of all steps and overall journey status 
}

IDWiseDynamic.getJourneySummary(onJourneySummary: (dynamic summary) {
       print("onJourneySummary: $summary")
 });

IDWiseDynamic.getJourneySummary( {
  onJourneySummary(summary) {
    console.log('onJourneySummary:', summary);
  },
  onError(error) {
    console.log('onJourneySummaryError:', error);
  },
});

IDWiseDynamic.getJourneySummary( {
  onJourneySummary(summary) {
    console.log('onJourneySummary:', summary);
  },
  onError(error) {
    console.log('onJourneySummaryError:', error);
  },
});

JourneySummary contains the following information

Field	Type	Description
journeyId	String	A unique identifier for the user journey.
isCompleted	Boolean	A boolean field that indicates if the journey is completed or not.
stepSummaries	List of StepSummary	An array of objects that detail the steps the user has gone through in the journey. Each object in this array contains a definition and a result.
journeyResult	JourneyResult	Result and Status of the verification Journey as described below

StepSummary contains the following information

Field	Type	Description
definition	StepDefinition	An object that describes the step.
result	StepResult	An object that contains the result of the step.

StepDefinition contains the following information

Field	Type	Description
step_id	Int	An identifier for the step within the journey.

JourneyResult contains the following information

Field	Type	Description
completedSteps	Int	Number of completed steps in the journey
interimRuleAssessment	InterimRuleAssessment	Enum for the combined Interim rules assessment result [Passed, Failed]
interimRuleDetails	HashMap<String, RuleDetail>	Hashmap of all the Rules Assessment Results applicable

RuleDetail contains the following information

Field	Type	Description
name	String	Name of the Rule
result	Result of the Rule Assessment	Enum for the combined Interim rules assessment result [Passed, Failed, CouldNotApply]

Error Feedbacks

You can access the table of error feedbacks, which includes descriptions for each of the feedback codes on here