Deepvue Aadhaar Offline e-KYC React Native SDK

This is a wrapper over Android and iOS SDK for react native.

Aadhaar Paperless Offline eKYC is a secure and shareable document which can be used by any Aadhaar holder for offline verification of identification. The Aadhaar Offline document can be obtained from the UIDAI website. This SDK provides a simple plugin to your mobile App which allows the user to seamlessly share their offline Aadhaar file with the service provider.

The Aadhaar Offline file will be validated for its digital signature and the KYC data of The Aadhaar holder will be passed to the integrating App as JSON data.

Table Of Content

• Prerequisite
• Setup
• Usage
• Failure Status Codes
• Help

Prerequisite

You will need valid credentials to use the Deepvue Aadhaar Offline e-KYC React Native SDK, which can be obtained by contacting [email protected]

Setup

Android

1. Open up android/build.gradle, Add below dependency under buildscript

buildscript {
  ext {
    kotlin_version = "1.4.21"
  }

  dependencies {
    classpath "org.jetbrains.kotlin:kotlin-gradle-plugin:$kotlin_version"
  }
}

2. After that, Open up android/build.gradle, Add below dependency under allprojects->repositories

allprojects {

    repositories {
          maven { url 'https://jitpack.io' }
    }

}

3. Post that, Open up android/app/build.gradle, Add below dependency under dependencies

// ...

dependencies {
    // Deepvue aadhar offline core dependency
    implementation 'com.github.deepvue-tech:deepvue-aadhaar-offline-ekyc-android-sdk:<lastest verison>'

}

4. After that, Copy below files and add to your app alongside MainApplication.java file
   • OkycPackager.java
   • OkycHandler.java
5. At last, Open up android/app/src/main/java/[...]/MainApplication.java
   • Add new OkycPackager() to the list returned by the getPackages() method

Usage

React Native Code

//Import Native modules from react native
import { NativeModules } from "react-native";

const clientId = "YOUR-CLIENT-ID";
const clientSecret = "YOUR-CLIENT-SECRET";
const baseUrl = "DEEPVUE-SERVER-BASE-URL"; // e.g. https://pre-production.deepvue.tech/v1

// No need to set imageUrl in default mode else can be set as your own e.g. https://i.imgur.com/Mfn9Srw.jpeg
const imageUrl = "YOUR-IMAGE-URL"; 

//use below code on button click to start offline kyc
NativeModules.OkycHandler.initSdk(
  clientId,
  clientSecret,
  baseUrl,
  imageUrl, //no need to set this in case of default mode
  (response) => {
    console.log(response);
  },
  (exception) => {
    console.log(exception);
  }
);

Failure Status Codes

Following error codes will be returned on the onFailure method of the callback

Help

For any queries/feedback, contact us at [email protected]