FacePlugin
Get in Touch
Android

ID Document Recognition SDK for Android

A native Android SDK for real-time ID card, passport, and driver license scanning – OCR, MRZ, and barcode/QR recognition, fully on-device and on-premise.

Fully on-deviceNative Kotlin/Java SDKNo 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 Android

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

Minimum Android versionAPI 24 (Android 7.0), API 29+ recommended
Build toolsAGP 8.5.2, Gradle 8.7, JDK 17
Architecturearm64-v8a (demo); AAR also ships armeabi-v7a, x86_64, x86
Hardware4 GB RAM min / 6 GB+ recommended, 4+ CPU cores, rear camera (1080p+autofocus recommended)
Test deviceA physical phone – the emulator is not 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 download documentreadersdk.aar from the linked runtime.
  • Place it at libdocsdk/documentreadersdk.aar, then open the project in Android Studio.
  • Run on a physical arm64 phone (the demo license is scoped to the com.faceplugin.documentreader application ID), grant camera access, and wait for “Ready.”
kotlin
Thread {
    var ret = setActivation(context, "YOUR_LICENSE_KEY")
    if (ret == SDK_SUCCESS) {
        ret = init(context)
    }
}.start()

// recognize(front, back, authenticity) -> JSON result
// authenticity = true also runs document-liveness checks
Licensing

How Licensing Works

Licenses are offline and bound to your app's application ID. The bundled demo key (for com.faceplugin.documentreader) is valid until 12 Aug 2027 – contact FacePlugin for a key scoped to your own app.

FAQ

Frequently Asked Questions

Does the Android 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 Android 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

iOS

Native Swift SDK, fully on-device.

Flutter

One plugin for Android and iOS.

ID Document Recognition SDK

The full product overview across every platform.

Ready to Add Document Recognition to Your Android App?

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