FacePlugin
Get in Touch
React Native

ID Document Recognition SDK for React Native

An on-device document-scanning SDK for React Native apps on Android and iOS – OCR, MRZ, and barcode/QR recognition as an npm package, fully on-premise.

Fully on-devicenpm packageNo per-call fees
PASSPORT• AURORIA
Portrait photo extracted from a scanned ID document
SURNAME

WILLIAMS

GIVEN NAMES

ETHAN L.

DATE OF BIRTH

22 SEP 1992

DOCUMENT NO.

X8295147

P<AURWILLIAMS<<ETHAN<L<<<<<<<<
X8295147<7AUR9209226M3205184<<<<03
MRZ Verified✓
Barcode Valid✓
OCR Complete✓
Identity Verified
Requirements

What You Need to Run It on React Native

These are the exact minimum and recommended requirements published in the ID-Document-Recognition-React-Native repository — check the repo directly for the latest version, since SDK requirements can change between releases.

ToolchainNode.js 18+, Yarn 3 (npm install is not supported)
React Native0.74.x tested
AndroidminSdk 24 (API 29+ recommended; some API 26 devices fail init()), JDK 17, NDK 26.1.10909125
iOS13.0 min / 16+ recommended, Xcode 15+, CocoaPods
Test deviceA physical arm64 device – Expo Go is not supported, a dev build is required
Quick Start

Install and Activate

Install the SDK, then activate it with a license key before calling any recognition function – every platform follows this same activate-then-initialize pattern.

  • yarn add document-reader-sdk@git+https://github.com/Faceplugin-ltd/ID-Document-Recognition-React-Native.git, then yarn install.
  • Run cd ios && pod install, then copy the native runtimes into node_modules/document-reader-sdk/ per the repo's path table.
  • Rebuild the native app – a JS-only reload isn't enough since this ships native code.
javascript
const machine = await getMachineCode(); // send when requesting a license
const act = await setActivation('YOUR_LICENSE_KEY');
if (act !== SDK_SUCCESS) throw new Error(`Activation failed: ${act}`);
const code = await init();
const json = await recognize('file:///path/to/front.jpg', null, true);
Licensing

How Licensing Works

Licenses are offline and bound to your app's application ID (Android) or bundle ID (iOS). Demo keys are valid until 12 Aug 2027 – contact FacePlugin for a key scoped to your own app.

FAQ

Frequently Asked Questions

Does the React Native SDK send document data to the cloud?

No. Every stage of document recognition runs on your own server or directly on the device, depending on the platform – scanned documents never leave an environment you control.

How is the SDK licensed?

Licenses are offline and bound to a machine code, application ID, or bundle ID depending on the platform. Contact FacePlugin with that identifier to receive a license key – there are no per-call or per-scan fees once licensed.

Where can I see the full source and open an issue?

The React Native integration is maintained publicly on GitHub at github.com/Faceplugin-ltd, where you can browse the code, file issues, and track releases.

Related

Pairs Well With

Android

Native Kotlin/Java SDK, fully on-device.

iOS

Native Swift SDK, fully on-device.

Flutter

One plugin for Android and iOS.

Ready to Add Document Recognition to Your React Native App?

Talk to our team to get a license key and a 15-day evaluation period started.