Ionic Cordova

Faceplugin ID Document Recognition Ionic Cordova SDK. Legacy DocumentReaderPlugin layout. Prefer Capacitor for new ID scanning apps.

Use this guide only if you already have a Cordova Ionic app. The native engine matches Capacitor. New projects should use Ionic Capacitor.

Code

GitHub - Faceplugin-ltd/ID-Document-Recognition-Ionic-Cordova: Ionic Cordova ID Document Recognition SDK for Android and iOS — scan and recognize ID cards, passports, and driver licenses with OCR, MRZ, barcode/QR scanning, live document detection, and automatic capture. On-device, on-premise identity verification.GitHub

How to run

✅ Setup Environment

Install Node.js, Ionic CLI, and Cordova. Physical device recommended (ionic serve cannot load the engine).

1. Place documentreadersdk.aar at DocumentReaderPlugin/src/android/documentreadersdk.aar.

2. Place docsdk.framework at DocumentReaderPlugin/src/ios/Frameworks/docsdk.framework.

3. Run:

npm install
npm run setup:android
npm run android

Gradle is bootstrapped via scripts/with-gradle.js. iOS: put your Apple Team ID in root build.json. Physical iPhone; docsdk is device arm64.

You can also add the plugin from a local path:

ionic cordova plugin add ./DocumentReaderPlugin
ionic cordova build android
ionic cordova run android

Drive: Android · iOS.

The Android demo license key string in this repo can differ from Capacitor / React Native / Flutter; it is still bound to com.faceplugin.documentreader.

APIs

Same activate → init → locate / recognize / documentRecognition / documentLiveness sequence as the other mobile Document Reader Apps. Status codes 0–4. Native camera helpers: startLivePreview / takeLiveSnapshot / stopLivePreview. Plugin folder: DocumentReaderPlugin/.

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>

recognize: This API is used to run FullProcess

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

Also: getMachineCode, locateDocument, documentRecognition, documentLiveness, getLicenseStatus, deinit.

Parse JSON with Document result JSON.

Request a License & Support · Contact us

FAQ

Legacy plugin? Yes. Prefer Ionic Capacitor for new apps.

Related documentation

• Faceplugin ID Document Recognition Mobile SDK · Ionic Capacitor · Glossary

• Face Recognition Ionic Cordova SDK

• Document result JSON

• Request a License · Status codes

• Combining products (eKYC) · SDK comparison