README.md

Android UIDAI RD-Service Manager

Android library to easily integrate fingerprint device support in your app (for UIDAI Aadhaar based secure authentication in India). Build your own AePS (Aadhaar based Cash-Out) or eKYC services for Android.

---

Introduction

As per UIDAI (Aadhaar) guidelines, only registered biometric devices can be used for Aadhaar Authentication & eKYC transactions. These devices come with RDService drivers (usually available on PlayStore) that exposes a standard API.

This library makes it easy to work with all such devices so that your app can search for installed drivers and get the fingerprint data after a scan.

For reference, you may check out the latest Aadhaar Registered Devices Technical Specification v2 by UIDAI

Usage

STEP 1: Add library in your Android project

Add jitpack in your root build.gradle file at the end of repositories:

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

Add UIDAI-RDService-Manager library dependency to your app build.gradle file:

Dependencies {
  // ...
  implementation 'com.github.ekoindia:android-uidai-rdservice-manager:1.3.0'
}

STEP 2: Use the library in your Activity

Implement RDServiceEvent interface in your Activity:

import in.eko.uidai_rdservice_manager_lib.RDServiceEvents;
import in.eko.uidai_rdservice_manager_lib.RDServiceManager;

public class MyActivity extends AppCompatActivity implements RDServiceEvents {

Initiate RDServiceManager in your activity's onCreate():

private RDServiceManager rdServiceManager;

@Override
protected void onCreate(Bundle savedInstanceState)
{
  // ...
  rdServiceManager = new RDServiceManager.Builder(this).create();
}

Setup onActivityResult() for RDService:

@Override
public void onActivityResult(int requestCode, int resultCode, Intent data) {
  super.onActivityResult(requestCode, resultCode, data);

  // Add this line -->
  rdServiceManager.onActivityResult(requestCode, resultCode, data);

  // ...
}

Setup RDService event callbacks in the yourActivity that implemented the RDServiceEvent interface:

@Override
public void onRDServiceDriverDiscovery(String rdServiceInfo, String rdServicePackage) {
  // Called when an installed driver is discovered
  //   rdServiceInfo: Status response as XML string from the discovered RDService device driver
  //   rdServicePackage: The discovered RDService device driver package name
  //   isWhitelisted: True if the discovered package is whitelisted, false otherwise
}

@Override
public void onRDServiceCaptureResponse(String pidData, String rdServicePackage) {
  // Called when fingerprint is successfully captured
  //   pidData: The fingerprint scan PID data as XML string
  //   rdServicePackage: The package name of the RDService driver
}

@Override
public void onRDServiceDriverDiscoveryFailed(int resultCode, Intent data, String rdServicePackage, String reason) {
  // Called when a discovered driver fails to provide a proper status information
  //   resultCode: The resultCode returned by the RDServiver driver activity
  //   data: The data returned by the RDServiver driver activity
  //   rdServicePackage: The package name of the RDService driver
}

@Override
public void onRDServiceDriverNotFound() {
  // Called when no installed driver is found
}

@Override
public void onRDServiceCaptureFailed(int resultCode, Intent data, String rdServicePackage) {
  // Called when fingerprint capture fails
  //   resultCode: The resultCode returned by the RDServiver driver activity
  //   data: The data returned by the RDServiver driver activity
  //   rdServicePackage: The package name of the RDService driver
}

Search for installed RDService drivers:

rdServiceManager.discoverRdService();

Initiate fingerprint capture:

rdServiceManager.captureRdService(data);

Configuration

TODO

Javadocs

https://ekoindia.github.io/android-uidai-rdservice-manager

Examples

TODO