Ionic Capacitor

Faceplugin ID Document Recognition Ionic Capacitor SDK. On-premise OCR, MRZ, and authenticity. document-reader-capacitor plugin for new Ionic apps.

Fully on-premise ID Document Recognition SDK for Ionic Capacitor. Package: document-reader-capacitor. Prefer this for new Ionic apps. Cordova is a different repo.

ionic serve / the browser cannot load the engine. Open Android Studio or Xcode and run on a physical phone.

Parse results with Document result JSON.

Code

GitHub - Faceplugin-ltd/ID-Document-Recognition-Ionic-Capacitor: ID document recognition SDK for Ionic Capacitor — scan ID cards, passports, and driver licenses with OCR, MRZ, barcode, and QR recognition. On-device and fully on-premise.GitHub

How to run

1

Install and build the plugin

git clone https://github.com/Faceplugin-ltd/ID-Document-Recognition-Ionic-Capacitor.git
cd ID-Document-Recognition-Ionic-Capacitor
npm install && npm run build
cd example && npm install

2

Place native runtimes

Platform	File	Example / plugin path
Android	documentreadersdk.aar	example/android/libdocsdk/ (your app: node_modules/document-reader-capacitor/android/libs/)
iOS	docsdk.framework	ios/Frameworks/

• Android Google Drive: documentreadersdk.aar

• iOS Google Drive: docsdk.framework

3

Sync and run

cd example
npx cap sync
npx cap open android

Or npx cap open ios. Add camera + photo-library permissions.

APIs

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

Call order: getMachineCode → setActivation → init → locateDocument / recognize → deinit.

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>

recognize: This API is used to run FullProcess

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

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, startLivePreview / takeLiveSnapshot, deinit.

Request a License & Support · Contact us

FAQ

Package? document-reader-capacitor. Prefer Capacitor over Cordova.

JSON contract? Document result JSON.

Related documentation

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

• Face Recognition Ionic Capacitor SDK

• Document result JSON

• Request a License · Status codes

• Combining products (eKYC) · SDK comparison