🛠️ react-native-rdservice-fingerprintscanner

React Native library to easily integrate Fingerprint Device support and Face capture via the AadhaarFaceRD app in your app (for UIDAI Aadhaar-based secure authentication in India). It is only for Android Devices.

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

This library makes it easy to work with all such devices and the AadhaarFaceRD app so that your app can:

• 🔍 Search for installed RDService drivers.
• ✋ Capture fingerprint data from registered devices.
• 😃 Capture face data via the AadhaarFaceRD app.

For reference, you may check out the following UIDAI documents:

• 📄 Version 2.0, Revision 6 – Aadhaar Registered Devices
• 📄 Version 2.0, Revision 7 – Aadhaar Registered Devices
• 📄 Version 2.5, Revision 1 – Aadhaar Authentication API

🚀 Version Support (Old Architecture vs New Architecture)

⚠️ Important Update (Version 2.x.x)

From v2.x.x, this library now supports React Native New Architecture using:

• ⚡ TurboModule Codegen
• 🧩 Fabric-compatible structure
• 🛠️ Kotlin (Android)

✅ Version Compatibility

| Package Version | Architecture | React Native Compatibility | Notes | | --------------- | ------------ | -------------------------- | ------ | | 2.x.x | New Architecture (TurboModules) | RN 0.76+ (or any version with New Architecture enabled) | Recommended. Better performance & bridging. | | 1.x.x | Old Architecture (Legacy Native Modules) | RN 0.63 – 0.75 | Backward compatibility only. No new features. |

📦 Installation

npm install react-native-rdservice-fingerprintscanner

⚙️ Android Setup

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

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

🔄 Migration Guide: 1.x.x → 2.x.x

If upgrading from Old Architecture → New Architecture:

| Old Name / Type | New Name / Type | | ------------------------------------ | ---------------------------- | | isDriverFound() | getIsDriverFound() | | All type/interface names (camelCase) | Capitalized (PascalCase) |

Notes:

• Call getIsDriverFound() instead of isDriverFound().

• Update all type/interface names in your code to the capitalized version for proper TypeScript support in v2.x.x.

📘 Usage

import {
  getDeviceInfo,
  captureFinger,
  getIsDriverFound,
  openFingerPrintScanner,
  captureFace,
  AVAILABLE_PACKAGES,
  DEFAULT_PID_OPTIONS,
} from 'react-native-rdservice-fingerprintscanner';

// ...

getDeviceInfo()
  .then((response) => {
    console.log(response, 'DEVICE DRIVER FOUND'); // Response about Device Driver
  })
  .catch((error) => {
    console.log(error, 'DEVICE DRIVER NOT FOUND'); //Failed to get device information
  });

captureFinger(pidOptions) // You can pass pidOptions (optional) to the "captureFinger" method; otherwise, it will use DEFAULT_PID_OPTIONS.
  .then((response) => {
    console.log(response, 'FINGER CAPTURE'); // FingerPrint Response
  })
  .catch((e) => {
    console.log(e, 'ERROR_FINGER_CAPTURE'); // Failed to capture the Fingerprint
  });

getIsDriverFound(PACKAGE_NAME) // You can use "AVAILABLE_PACKAGES" for the PACKAGE_NAME
  .then((res) => {
    console.log(res, 'DRIVER CHECK');
  })
  .catch((error) => {
    console.log(error, 'ERROR_DRIVER CHECK');
  });

openFingerPrintScanner(PACKAGE_NAME, pidOptions) // You can pass pidOptions (optional) to the "openFingerPrintScanner" method; otherwise, it will use DEFAULT_PID_OPTIONS
  .then((res) => {
    console.log(res, 'FINGER CAPTURE');
  })
  .catch((e) => {
    console.log(e, 'ERROR_FINGER_CAPTURE');
  });

captureFace(pidOptions) // You should pass pidOptions to the "captureFace" method. The DEFAULT_PID_OPTIONS will not work for this method
  .then((response) => {
    console.log(response, 'FACE CAPTURE'); // Face Response
  })
  .catch((e) => {
    console.log(e, 'ERROR_FACE_CAPTURE'); // Failed to capture the Face
  });

🛠️ Using pidOptions and RD Service Methods

pidOptions is an XML string that you need to pass to the captureFinger, openFingerPrintScanner and captureFace methods.

Refer to Version 2.0 of UIDAI Revision 6 and Revision 7 documents for pidOptions used in captureFinger and openFingerPrintScanner methods.

The pidOptions passed to the captureFace method should include the wadh value, which is an encrypted hash key encoded in Base64.

Refer to Version 2.5 of UIDAI Revision 1 document for pidOptions used in captureFace method.

DEFAULT_PID_OPTIONS is used when you not passed the pidOptions to the captureFinger() and openFingerPrintScanner Methods.

PACKAGE_NAME is required to check the rd service. (eg) The Package name of StarTek Device is com.acpl.registersdk

You can use AVAILABLE_PACKAGES for PACKAGE_NAME.

📝 Usage Notes

• Always call captureFinger after receiving a response from getDeviceInfo.

  • Calling it before will result in an error in the catch block.(refer to the example code)

• Only call openFingerPrintScanner after getIsDriverFound returns true.

  • If the driver is not found, openFingerPrintScanner will return a “driver not found” error.

• The methods getIsDriverFound and openFingerPrintScanner are used to locate the selected RD Service.

  • Pass the device driver package name as an argument to these methods.

• The AadhaarFaceRD app must be installed to use the captureFace method.

📄 Response JSON Object

getDeviceInfo() Method Reponse

| Key | Value | Description | | ---------- | ------- | ------------ | | status | -1 or 1 or 0 | -1 - Device Driver not Found, 1 - READY, 0 - NOTREADY | | isWhitelisted | true or false | IT is about the Device is Approved or not. true - Approved, false - Not Approved | | rdServiceInfoJson | JSON DATA | The device returns XML DATA of Device Information. this parameter contains converted JSON DATA of XML DATA | | rdServiceInfoXML | XML DATA | Device Information | | rdServicePackage | Device Package | | message | Message about Success or Failure |

captureFinger() and openFingerPrintScanner() Methods Reponse

| Key | Value | Description | | ---- | ------- | ----------- | | status | 1 or 0 | 1 - Fingerprint Captured Successfully, 0 - FingerPrint not Captured (Check Connection of Device and OTG Connection Settings in Mobile) | | errorCode | ERROR CODE from RD Service | Refer UIDAI Document and RDService Error Details | | errInfo | Error Message according to the ERROR CODE | Refer UIDAI Document and RDService Error Details | | pidDataJson | JSON DATA | The device returns PID DATA of Captured Fingerprint. this parameter contains converted JSON pidData of XML pidData | | pidDataXML | XML DATA | pidData Captured Fingerprint | rdServicePackage | Device Package | | message | Message about Success or Failure |

getIsDriverFound() Method Response

| Key | Value | Description | | ------------------- | -------- | ---------- | | isDeviceDriverFound | true or false | true - Driver Found, false - Driver not found | | message | Message about the driver found or not |

captureFace() method Reponse

| Key | Value | Description | | ---------------- | ------------------ | --------- | | status | 1 or 0 | 1 - Face Captured Successfully, 0 - Face not Captured | | errorCode | ERROR CODE from RD Service | Refer UIDAI Document | | errInfo | Error Message according to the ERROR CODE | Refer UIDAI Document | | pidDataJson | JSON DATA | The AadhaarFaceRD app returns PID data of the captured face. This parameter contains the JSON-converted version of the XML PID data | | pidDataXML | XML DATA | PID data of the captured face | | message | Message about Success or Failure |

✅ Tested Devices

| Device Name | Result| | ------------- | ------| | Startek FM220 | ✅ | | MORPHO | ✅ | | MANTRA | ✅ | | Tatvik TMF20 | ✅ | | PB510 | ✅ |

🤝 Contributing

See the contributing guide to learn how to contribute to the repository and the development workflow.

📜 License

MIT

☕ Would you like to support me?