Android Dynamic SDK Integration

Introduction

IDWise dynamic SDK offers more control over the journey and step order, and allows your app to show custom screens between ID verification steps. In this mode you start each step explicitly and your app regains UI control after each one.

📘

Important

Please familiarise yourself with end to end sequence diagram for Dynamic SDK Integration

Starting a new journey in dynamic mode

First ensure you have added the android SDK dependency and initialize the SDK as in Step 1 and Step 2.

Once the SDK is initialized, it becomes ready to start an ID verification journey flow. To commence the flow, articulated below methods are offer by SDK to start the journey in dynamic mode:

IDWise.startDynamicJourney(
  context,
  "<FLOW_ID>", //Provided by IDWise
  "<REFERENCE_NUMBER>", 
  "en",
  journeyCallback,
  stepCallback
)

This method takes the following parameters:

Journey Callbacks

This section provides comprehensive details about journey-level callbacks.

val journeyCallback = object : IDWiseSDKCallback {
  override fun onJourneyStarted(journeyInfo: JourneyInfo) {
    Log.d("IDWiseSDKCallback", "onJourneyStarted")
  }

  override fun onJourneyCompleted(journeyInfo: JourneyInfo,isSucceeded: Boolean) {
    Log.d("IDWiseSDKCallback", "onJourneyCompleted")
  }

  override fun onJourneyResumed(journeyInfo: JourneyInfo) {
    Log.d("IDWiseSDKCallback", "onJourneyResumed")
  }

  override fun onJourneyCancelled(journeyInfo: JourneyInfo?) {
    Log.d("IDWiseSDKCallback", "onJourneyCancelled")
  }

  override fun onError(error: IDWiseSDKError) {
    Log.d("IDWiseSDKCallback", "onError ${error.message}")
  }
})

Step Callbacks

This section provides comprehensive details about step-level callbacks.

val stepCallback = object : IDWiseSDKStepCallback {
  override fun onStepCaptured(stepId: String, bitmap: Bitmap?, croppedBitmap: Bitmap?) {
    //This event triggers when User has captured the image from the camera
  }

  override fun onStepResult(stepId: String, stepResult: StepResult?) {
    //This event is triggered when Image processing is completed at the backend.
    //stepResult contains the details of the processing output
    Log.d("onStepResult", "Step $stepId result!!")
  }

  override fun onStepConfirmed(stepId: String) {
    Log.d("onStepConfirmed", "Step $stepId confirmed!!")
  }
  
  override fun onStepCancelled(stepId: String) {
    Log.d("onStepCancelled", "Step $stepId cancelled!!")
  }
  
  override fun onStepSkipped(stepId: String) {
    Log.d("onStepSkipped", "Step $stepId skipped!!")
  }
}

Starting the Steps

To start a specific step in the journey you should follow:

• Call IDWise.startStep(context, stepId) or IDWise.startStepFromFileUpload(context, stepId, byteArray) method inside onJourneyStarted(...)or onJourneyResumed(...) where:
  • context : Activity of Fragment
  • stepId : ID of the step you want to start. (Will be provided by IDWise for each step)

🚧

Note

When using startStepFromFileUpload ensure that the byteArray adheres to the requirements specified here

• The following callbacks will be triggered in this order:
  • onStepCaptured: This callback is triggered when data is submitted, but processing is not yet complete.
  • onStepResult: This callback is triggered once the processing of the step is finished. The results you will receive in this callback can be found here.

Skipping the Step

When onJourneyStarted(...)or onJourneyResumed(...) are triggered successfully, you can call the IDWise.skipStep(...) to skip any verification Step. (Added support from version 4.5.9)

IDWise.skipStep(stepId)

This method takes only one parameter:

• stepId : ID of the step you want to skip. (Will be provided by IDWise for each step)

The step events (provided in IDWiseSDKStepCallback parameter provided to startDynamicJourney or resumeDynamicJourney method) will be triggered as step is skipped.

Step Result Payload

The payload of onStepResult callback has the following information:

DocumentRecognition

This object contains the following information related to the scanned document.

FieldValue

This object has the following properties

NFCResult

This object contains the following data extracted from the Document via reading the NFC chip

All extractedFields from the NFC can be found here

📘

NFC Chip Reading

To enable NFC Chip Reading, special configuration need to be carried out. Please get in touch with IDWise Support for more information.

Get Summary of the Verification Journey

You can get the Status of the journey anytime by calling the following function

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

Journey Summary Result

When you are calling getJourneySummary method, the result callback will return a JourneySummary object which contains the following information:

StepSummary

This object contains the following information:

StepDefinition

This object contains the following information:

JourneyResult

This object contains the following information:

RuleDetail

This object contains the following information

Error Feedbacks

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

Resuming a dynamic journey

IDWise.resumeDynamicJourney(
  context,
  "<FLOW_ID>", //Provided by IDWise
  "<JOURNEY_ID>", 
  "en",
  journeyCallback,
  stepCallback
)

This method takes the following parameters:

• flowId: (also called Journey Definition ID): This is a unique identifier that identifies your journey flow. IDWise shares this with you when you register to use IDWise system.
• journeyId: This is a unique identifier that identifies your journey and it can be used to resume. This is received in the implementation of journeyCallback interface in onJourneyStarted method when you started journey first time.
• locale: (Optional)This refers to the ISO code representing the desired language for the user interface components. Please reach out to IDWise Support for the list of available languages.
• IDWiseSDKCallback: The implementation of the callback is in the preceding section.
• IDWiseSDKStepCallback: The implementation of the callback is in the preceding section.

Finishing a dynamic journey

This method is used to finish the ongoing journey, you can call once all the required the steps are concluded.

IDWise.finishDynamicJourney()

The journey events (provided in IDWiseSDKCallback parameter provided to startDynamicJourney or resumeDynamicJourney method) will be triggered as journey is completed.

Unloading the SDK

You can unload the SDK when it is no longer required to free up the resources

IDWise.unloadSDK()

The journey events (provided in IDWiseSDKCallback parameter provided to startDynamicJourney or resumeDynamicJourney method) will be triggered as journey is completed.

Extracted Fields

📘

Sample Project

You can find the sample project for a complete Android Integration in dynamic mode.