FacePlugin
Get in Touch
Ionic Capacitor

ID Document Recognition SDK for Ionic Capacitor

Scan ID cards, passports, and driver licenses in an Ionic Capacitor app on Android and iOS – OCR, MRZ, and barcode/QR recognition, fully on-device.

Fully on-deviceAndroid & iOSNo 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 Ionic Capacitor

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

ToolchainNode.js 18+, Capacitor 6 (Ionic React in the example app)
AndroidAPI 24 min / API 29+ recommended, JDK 17, Android Studio, physical phone
iOS13.0 min / 16+ recommended, iPhone A12+, Xcode 15+, CocoaPods
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.

  • Clone the repo, run npm install && npm run build at the root, then cd example && npm install.
  • Download the native runtimes, copy documentreadersdk.aar to example/android/libdocsdk/ and docsdk.framework to ios/Frameworks/.
  • Run npm run build again, then npx cap sync and npx cap open android (or ios) to run on a physical device.
typescript
const act = await setActivation(YOUR_LICENSE_KEY);
if (act !== SDK_SUCCESS) throw new Error('activation failed');
const code = await init();
const json = await recognize(frontUri, backUri ?? 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. getMachineCode() returns the identifier to send FacePlugin for your own license.

FAQ

Frequently Asked Questions

Does the Ionic Capacitor 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 Ionic Capacitor 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

Ionic Cordova

Document scanning for Cordova apps on Android and iOS.

React Native

On-device document scanning as an npm package.

Flutter

One plugin for Android and iOS.

Ready to Add Document Recognition to Your Ionic Capacitor App?

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