Android

Faceplugin ID Document Recognition Android SDK. On-premise OCR, MRZ, barcode, and authenticity. documentreadersdk.aar in libdocsdk, not libfacesdk.

Fully on-premise ID Document Recognition SDK for Android. Reads passports, national IDs, and driver licenses. Place documentreadersdk.aar in libdocsdk/, not libfacesdk/.

Public class: com.faceplugin.documentreadersdk.DocumentReaderSDK. Demo id: com.faceplugin.documentreader.

Code

GitHub - Faceplugin-ltd/ID-Document-Recognition-Android: Android ID Document Recognition SDK for real-time ID card, passport, and driver license scanning with OCR, MRZ, barcode/QR recognition, document detection, and automatic capture. Fully on-device and on-premise.GitHub

Setup

1. Copy the SDK (libdocsdk folder) to the root folder in your project. Place documentreadersdk.aar from Google Drive inside libdocsdk/.

2. Add SDK to the project in settings.gradle

rootProject.name = "YourProjectName"
include ':app'
include ':libdocsdk'

1. Add dependency to your build.gradle

implementation project(path: ':libdocsdk')

1. minSdk 24, JDK 17. Call setActivation → init off the UI thread.

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

APIs

setActivation: This API is used to activate the SDK

public static int setActivation(Context context, String license);

init: This API is used to initialize the SDK

public static int init(Context context) throws IOException;

getMachineCode: This API is used to retrieve the machine code

public static String getMachineCode(Context context);

getLicenseStatus: This API is used to read recognition and authenticity flags

public static String getLicenseStatus();
public static String lastLicenseError();

locateDocument: This API is used to find document corners on a preview frame

public static String locateDocument(Bitmap bitmap);

Input	Preview bitmap.
Return value	JSON: corners + score. No OCR. Use for the overlay only.

Also: locateVideoFrame(byte[] nv21, int width, int height, int rotation) for camera NV21 frames.

recognize: This API is used to run FullProcess (OCR / MRZ / barcode / authenticity)

public static String recognize(Bitmap bitmap);
public static String recognize(Bitmap front, Bitmap back, boolean authenticity);
public static String recognize(Bitmap front, Bitmap back, String authenticityMode);

Input	One image, or front + optional back. Authenticity "normal" / "none" or boolean.
Return value	JSON: OCR / MRZ / barcode, verification, image quality, crops, security (if licensed).

Verification: 0 Pass, 1 Fail, 2 Not checked.

documentRecognition: This API is used to run OCR / MRZ / barcode / image quality only

public static String documentRecognition(Bitmap front);
public static String documentRecognition(Bitmap front, Bitmap back);

Authenticity is always off.

documentLiveness: This API is used to run authenticity / security only

public static String documentLiveness(Bitmap front);
public static String documentLiveness(Bitmap front, Bitmap back);

OCR / MRZ / barcode / image quality are always off.

startNewSession: This API is used to open a FullProcess session before recognize

DocumentReaderSDK.startNewSession("{\"scenario\":\"FullProcess\",\"series\":false}");

deinit: This API is used to unload the engine

public static String deinit();

deinit() returns a String (not int).

Run the demo

1. Place documentreadersdk.aar in libdocsdk/ (not libfacesdk).

2. Keep the demo package name com.faceplugin.documentreader.

3. Run on a physical phone.

4. Home: Camera, Gallery, About. Result tabs: OCR / MRZ / barcode, Liveness (security), Images, Raw JSON.

Screenshots

Home	Camera	Gallery

Result	Security	Images

License

Licenses are offline. Request a new license key for your own app. Parse the JSON with Document result JSON.

Try it (after the demo compiles)

DocumentReaderSDK.setActivation(context, DEMO_LICENSE);
DocumentReaderSDK.init(context);
String json = DocumentReaderSDK.recognize(front, back, "normal");

Request a License & Support · Contact us

FAQ

Passport OCR on Android? Yes. DocumentReaderSDK.recognize / documentProcess return OCR, MRZ, barcode, and crops. See Document result JSON.

Offline? Yes after setActivation / init with a license key for the demo app id (or yours).

Related documentation

• Faceplugin ID Document Recognition Mobile SDK · iOS · Glossary

• Face Recognition Android SDK

• Face Liveness Detection Android SDK

• Document result JSON

• Request a License · Status codes

• Combining products (eKYC) · SDK comparison