Getting the Journey Summary

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: { journeySummary, error in

})

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

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

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

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

JourneySummary

The journeySummary object received in callback contains the following information:

Field	Type	Description
journeyId	String	A unique identifier for the user journey.
isCompleted	Boolean	A boolean attribute that signifies whether the journey has been finished. Once a journey is marked as complete, it cannot be modified.
stepSummaries	List of StepSummary	A list of StepSummary object, each representing a step in the journey. The provides information about each step and its statuses.
journeyResult	JourneyResult	Result and Status of the verification Journey as described below

StepSummary

StepSummary object 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

StepDefinition object contains the following information:

Field	Type	Description
stepId	Integer	An identifier for the step within the journey.

StepResult

StepResult objects contains the following information:

Field	Type	Description
nfcResult	NFCResult	Details for NFC scanning (If applicable)
recognition	DocumentRecognition	Details of the document recognition
errorUserFeedbackCode	String	A code that can be used to indicate the error. All the error feedback codes can be found HERE
errorUserFeedbackTitle	String	A title for the error message directed at the user, providing feedback in case an error occurs during the step.
errorUserFeedbackDetails	Strings	Description of the error message directed at the user, providing feedback in case an error occurs during the step.
hasPassedRules	Boolean	Indicates whether the user has successfully passed the validation rules for the step or not.
isConcluded	Boolean	Indicates whether the step has been completed, either by passing all rules or by the user exhausting all retry attempts.
status	StepStatus	Enum indicating the current status of the Step
extractedFields	HashMap<String, FieldValue>	Key-Value pair of the extracted fields from the document's OCR

NFCResult

NFCResult objects contains the following information:

Field	Type	Description
facePhoto	Image	Bitmap/Image of face photo from the Document chip
extractedFields	HashMap<String, FieldValue>	Key-Value pair of the extracted fields from the document's Chip scanning

DocumentRecognition

DocumentRecognition objects contains the following information:

Field	Type	Description
issuingCountryCode	String	Country code of the issuing country
issuingCountryName	String	Name of the issuing country
documentType	String	Type of the Document e.g. Passport, ID Document, Driving license

StepStatus

StepStatus enum has following possible values

Field	Value	Description
NOT_SUBMITTED	Not Submitted	The step is not submitted yet
SUBMITTED	Submitted	The step is submitted and concluded
INCOMPLETE	Incomplete	The step is incomplete, (only 1 side of document is submitted yet)
IN_PROGRESS	In Progress	The submitted images are being processed

JourneyResult

JourneyResult objects contains the following information:

Field	Type	Description
completedSteps	Int	Number of completed steps in the journey
interimRuleAssessment	InterimRuleAssessment	Represents the current status of the journey rules executed up to this point, which can either, `Failed` or `Passed`.
interimRuleDetails	HashMap<String, RuleDetail>	Key-Value map of all the Rules Assessment Results applicable. Offers detailed insights into journey-level rules executed up to this point.

RuleDetail

RuleDetail object contains the following information

Field	Type	Description
name	String	Name of the rule, all rule name can be found here.
result	Result of the Rule Assessment	Enum for the combined Interim rules assessment result [`Passed`, `Failed`, `CouldNotApply`]

Rule Name

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

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

FieldValue

FieldValue object contains the following information:

Rule Name	Type	Description
value	String	Value of the extracted field

Error Feedbacks

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