Ctrlk
For the complete documentation index, see llms.txt. This page is also available as Markdown.

Mobile

Faceplugin ID Document Recognition Mobile SDK. On-premise passport OCR and ID card verification for Android, iOS, Flutter, React Native, and Ionic.

Capture and read identity documents on the device. Camera locate overlay (corners only — no OCR on every frame), then recognize / documentProcess for OCR, MRZ, barcode, image quality, and optional authenticity.

Every platform returns the same field set: Document result JSON. Authenticity names: Document security check fields.

For HTTP APIs on Windows, Linux, and Docker, use Server SDK. Prefer Ionic Capacitor over Cordova for new Ionic apps.

Cover

Android SDK

Native AAR. Camera, Gallery, and Result screens.

Cover

iOS SDK

docsdk.framework. Same Camera and Gallery flow as Android.

Cover

Flutter SDK

document_reader_sdk plugin plus an example app.

Cover

React Native SDK

document-reader-sdk plugin. Yarn 3, not Expo Go.

Cover

Ionic Capacitor SDK

document-reader-capacitor for new Ionic apps.

Cover

Ionic Cordova SDK

Legacy Cordova plugin. Prefer Capacitor for new projects.

FAQ

Does this do passport OCR on the phone? Yes. recognize / documentProcess return OCR, MRZ, barcode, and crops. See Document result JSON.

Is authenticity included? Only with a Liveness-capable license. Otherwise use ID Document Liveness.

Related documentation

PreviousRecognition + Liveness
NextAndroid

Last updated