Get in Touch

Solutions Biometric Authentication ID Verification & eKYC Products All SDKs Face Recognition SDK Face Liveness Detection SDK Deepfake Detection SDK ID Document Recognition SDK ID Liveness Detection SDK ID Verification SDK Suite Pricing Resources Blogs Documentation About Us

Ionic Cordova

ID Document Recognition SDK for Ionic Cordova

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

Get in Touch View on GitHub

Fully on-deviceAndroid & iOSNo per-call fees

PASSPORT• AURORIA

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 Cordova

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

ToolchainNode.js 18+, npm, Cordova CLI, JDK 17, Android SDK

AndroidAPI 24 min / API 29+ recommended, physical phone

iOSmacOS + Xcode 15+, physical iPhone A12+, 13.0 min / 16+ recommended

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 and run npm install at the root.
Android: place documentreadersdk.aar at DocumentReaderPlugin/src/android/, then npm run setup:android && npm run android.
iOS (on macOS): place docsdk.framework at DocumentReaderPlugin/src/ios/Frameworks/, set your Apple Team ID in build.json, then npm run setup:ios && npm run ios.

javascript

import { setActivation, init, recognize, normalizeResult } from 'document-reader-cordova';

await setActivation({ license: YOUR_LICENSE_KEY });
await init();
const json = await recognize(frontPathOrBase64, backOptional);
const result = normalizeResult(json);

Licensing

How Licensing Works

Licenses are offline and bound to your app's application identifier. Demo keys are valid until 12 Aug 2027 – a new key is only needed if you use a different app identifier.

FAQ

Frequently Asked Questions

Does the Ionic Cordova 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 Cordova integration is maintained publicly on GitHub at github.com/Faceplugin-ltd, where you can browse the code, file issues, and track releases.

Ready to Add Document Recognition to Your Ionic Cordova App?

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

Contact Sales Explore the SDKs