IDWise Simple SDK for React-Native

Table of contents
  1. Not Already a Customer?
  2. Requirements
  3. Step 1: Integrating with your build scripts
  4. Step 2: Linking
  5. Step 3: React-Native Usage
    1. Initializing the SDK
    2. Starting the Journey
    3. Events (Callbacks)
  6. If you use Proguard
  7. Sample Project

Not Already a Customer?

Get IDWise Free Trial Now

In an increasingly digital world, relying solely on conventional and manual remote validation methods involving database checks, IP addresses and credit bureau checks is cumbersome, inefficient and opens your customers’ sensitive data to a variety of data breach security risks. IDWise’s cutting-edge document verification, face match and liveness detection solution establishes a robust layer of trust between your business and your prospective customer so that you can focus your effort on developing your business faster and with more confidence while stopping even the most sophisticated fraudsters in their tracks.

This git repository contains the official IDWiseSDK meant to be used in React-Native applications. This README contains all the needed information to test and integrate the IDWiseSDK in your React-Native project.


The minSdkVersion is 16 and targetSdkVersion is set to 31 in IDWise Android SDK. It is recommended to install the Latest Android Studio on your development machine.

Step 1: Integrating with your build scripts

Add the following in your app level build.gradle file located at projectRoot/android/app/build.gradle

android {
  defaultConfig {
    multiDexEnabled true
  buildFeatures {
    dataBinding true

Add following repositories in you project-level build.gradle file located at projectRoot/android/build.gradle

repositories {
  maven {
    url ''
    allowInsecureProtocol = true
  maven { url '' }

Finally, Add the following dependency in your app level build.gradle file located at projectRoot/android/app/build.gradle. Replace the x.y.z with the latest IDWise SDK version

dependencies {
  implementation 'com.idwise:android-sdk:x.y.z'

To support RTL, add the following attribute in application tag in your project’s AndroidManifest.xml file located at projectRoot/android/app/src/main/AndroidManifest.xml


Step 2: Linking

In order to Link the React Code with android, we need to create a Module, let’s call it IDWiseModule. You can find the sample for sample code.

In order to use IDWiseModule we need to create a React Package, let’s call it IDWisePackage. You can find the sample for sample code.

Add both classes to your android application module. Now we can add IDWisePackage to our packages, to do this, we need to edit the, located at projectRoot/android/your/package/name/../ In getPackages() method, we need to add our Package like below. You can find the sample for sample code.

protected List<ReactPackage> getPackages() {
  List<ReactPackage> packages = new PackageList(this).getPackages();

  //add IDWisePackage here
  packages.add(new IDWisePackage());

  return packages;

Step 3: React-Native Usage

Invoking IDWise SDK is very simple. First reterieve IDWiseModule from NativeModules in your .js file from where you want to invoke IDWise SDK:

const { IDWiseModule } = NativeModules;

Initializing the SDK

In order to use the SDK, we need to initialize it first with the <CLIENT_KEY> provided by IDWise and a theme parameter. You can pre-load this on componentDidMount() if you want to. Here is how we can initialize the SDK.

IDWiseModule.initialize("<CLIENT_KEY>", theme);

Starting the Journey

Now we can start the verfication journey by calling startJourney(..) of the SDK which takes the following parameters.

  • journeyDefinitionId: (also called Journey Definition ID): This is a unique identifier that identifies your journey definition. IDWise shares this with you when you register for using IDWise system.
  • referenceNo: (Optional) A parameter that you can use to associate an arbitrary identifier (reference number) with the user making the current journey. This is helpful to link the journey back to the user and/or application that started the journey, you will recieve this in the webhook request.
  • locale: (Optional), iso code of locale (language) for the UI elements (please contact IDWise support for the list of supported locales, we are happy to support more upon reqiest).

This will start the verification process and that’s it.


Events (Callbacks)

Throughout the journey, IDWise SDK sends back some events to the Hosting app. Here we can listen to those events:

These are the supported events:

  • onJourneyStarted: Triggered when the journey is started and the Journey ID is assigned.
  • onJourneyFinished: Triggered when the journey is completed by the user.
  • onJourneyCancelled: Triggered when the user cancels the journey and doesn’t finish it.
  • onError: Triggered when an error occurs for example a network connectivity error and lack of permission to access the camera.

useEffect(() => {
  const eventEmitter = new NativeEventEmitter(NativeModules.IDWiseModule);

  eventEmitter.addListener('onError', (event) => {
    console.log(`An Error has occured  ${event.errorCode} : ${event.errorMessage}`); 

  eventEmitter.addListener('onJourneyStarted', (event) => {
      console.log(`Journey Started with id ${event.journeyId}`); 

  eventEmitter.addListener('onJourneyFinished', (event) => {
    console.log(`Journey Completed with id ${event.journeyId}`);

  eventEmitter.addListener('onJourneyCancelled', (event) => {
    console.log(`Journey Cancelled with id ${event.journeyId}`); 
}, []);

If you use Proguard

You need to update your build as follow:

// generate release apk
buildTypes {
	release {
		signingConfig signingConfigs.release

			proguardFile '../'
		minifyEnabled true
		//enableR8 code Shrinking & Obfuscation
		shrinkResources true

And add the following file to your app, in case the first simpler configuration doesn’t work, please try the second more comprehensive configuration in

Sample Project

You can find the Simple Journey Sample Project for sample code for React-Native Integration.