Overview

How to use IDWise SDKs

Overview

IDWise SDKs are a set of tools that enable you to integrate services provided by IDWise into your mobile or web applications. With IDWise SDKs, you can provide a seamless and secure user experience for your customers.

Use our SDKs to integrate our prebuilt UX into your existing applications.

Integration step

📘

Please refer to each SDK to get a detailed information with sample code on how to integrate the SDK with your app.

The typical flow of using IDWise SDKs consists of the following steps:

Add the IDWise SDK to your project dependencis

The first step is to add the IDWise SDK to your project dependencies, following the instructions for your platform (iOS, Android, or Web).

Initialize the SDK

You need to initialize the SDK with your API key and other configuration options, such as error callbacks and the used theme.

the language, the flow id, and the callback URL. This step should be done once when your application launches or before starting a journey.

Start a new journey

Once the SDK is initialized, it becomes ready to start an ID verification journey flow. To commence the flow, the SDK offers a startJourney method where you specify the following values:

  • flow_id Which represent a predefined sequence of steps that guides the user through the identity verification process.
    This value will be provided by IDWise.
  • reference_number (AKA user_id) to the SDK which is a value specified from your side.
  • locale Where you can specify the locale you'd like to use such as en or ar (Refer to the related docs for the full list of available locales)

The SDK will then launch a web view or a native view that displays the journey UI.

Control the journey with IDWise SDK

The SDK will handle all the user interactions, validations, and communications with the IDWise backend during the journey. You can also use the SDK methods to pause, resume, or cancel the journey at any time.

Listen to events

The SDK will emit events to notify you about the status and progress of the journey.

For example, you can listen to events such as journeyFinished or journeyCancelled to know when the user completes or aborts the journey, you can also get more information from these events.

Return to your app

When the journey is finished or cancelled, the SDK will close the web view or native view and return to your app. You can then use the event data to redirect the user to the appropriate screen in your app. For example, you can tell the user that their information has been submitted and that you will get back to them soon.

Subscribe to webhooks

When IDWise completes processing a journey, it will trigger the webhook that you have specified to notify you about the journey progress. You can find more details about the available events and the data they contain in the webhooks documentation.

After receiving the notification that the journey is finished, you can use the Result Retrieval APIs to get the result and update the user profile accordingly. You can then inform your user that their account is activated or that they need to provide more information.

What is the difference between simple and dynamic journeys