React Native

Faceplugin ID Document Recognition React Native SDK. On-premise OCR, MRZ, and authenticity. document-reader-sdk plugin, not Expo Go.

Fully on-premise ID Document Recognition SDK for React Native. Package: document-reader-sdk. Not Expo Go. Physical arm64 device.

Android output is normalized to the iOS-shaped JSON. Parse it with Document result JSON.

Code

GitHub - Faceplugin-ltd/ID-Document-Recognition-React-Native: React Native ID Document Recognition SDK for Android and iOS with on-device OCR, MRZ, barcode/QR scanning, automatic document detection, classification, and capture for ID cards, passports, and driver licenses. Fully on-premise with no identity data leaving the device.GitHub

How to Run

1

Install tools

Node 18+, Yarn, React Native environment. Use Yarn as in the repo. Not Expo Go.

2

Clone and install

git clone https://github.com/Faceplugin-ltd/ID-Document-Recognition-React-Native.git
cd ID-Document-Recognition-React-Native
yarn
cd example && yarn

3

Place native runtimes

Platform	File	Example app path	Your own app path
Android	documentreadersdk.aar	example/android/libdocsdk/	node_modules/document-reader-sdk/android/libs/
iOS	docsdk.framework	ios/Frameworks/	node_modules/document-reader-sdk/ios/Frameworks/

• Android Google Drive: documentreadersdk.aar

• iOS Google Drive: docsdk.framework

4

Run on a phone

yarn
cd example
yarn android

iOS: cd example/ios && pod install, then open the workspace. Wait until Home shows Ready.

Keep demo ids: Android com.faceplugin.documentreader, iOS com.faceplugin.documentreader.app. Android: minSdkVersion 24 and abiFilters 'arm64-v8a'.

License

Licenses are offline. Install from GitHub, not npm:

yarn add document-reader-sdk@git+https://github.com/Faceplugin-ltd/ID-Document-Recognition-React-Native.git

Rebuild the native app after install — a JS reload is not enough.

Integrate into your own app

import {
  getMachineCode,
  setActivation,
  init,
  recognize,
  locateDocument,
  SDK_SUCCESS,
} from 'document-reader-sdk';

const act = await setActivation('license key');
if (act === SDK_SUCCESS) await init();
const locateJson = await locateDocument(imageUri);
const resultJson = await recognize(frontUri, backUri, 'normal');

Permissions: CAMERA + photo library (READ_MEDIA_IMAGES / READ_EXTERNAL_STORAGE maxSdk 32; NSCameraUsageDescription / NSPhotoLibraryUsageDescription).

APIs

Status codes: 0 Success, 1 Invalid license, 2 Expired, 3 Not activated, 4 Init failed.

setActivation: This API is used to activate the SDK

setActivation(license: string): Promise<number>

init: This API is used to initialize the SDK

init(): Promise<number>

getMachineCode: This API is used to retrieve the machine code

getMachineCode(): Promise<string>

locateDocument: This API is used to find document corners on a preview frame

locateDocument(image: ImageInput): Promise<string>

No OCR. Overlay only.

recognize: This API is used to run FullProcess

recognize(front, back?, authenticity?): Promise<string>

Authenticity: true / false or 'normal' / 'none'.

documentRecognition: This API is used to run OCR / MRZ / barcode / image quality only

documentRecognition(front, back?): Promise<string>

documentLiveness: This API is used to run authenticity / security only

documentLiveness(front, back?): Promise<string>

Also: getLicenseStatus, startNewSession, deinit.

Request a License & Support · Contact us

FAQ

Package? document-reader-sdk. Yarn 3; not Expo Go.

Same JSON as iOS? Yes — the plugin normalizes Android output. See Document result JSON.

Related documentation

• Faceplugin ID Document Recognition Mobile SDK · Flutter · Glossary

• Face Recognition React Native SDK

• Document result JSON

• Request a License · Status codes

• Combining products (eKYC) · SDK comparison