Flutter

Faceplugin ID Document Recognition Flutter SDK. On-premise OCR, MRZ, and authenticity. document_reader_sdk plugin for Android and iOS.

Fully on-premise ID Document Recognition SDK for Flutter. Package: document_reader_sdk. Android output is normalized to the iOS-shaped JSON. Parse it with Document result JSON.

Code

GitHub - Faceplugin-ltd/ID-Document-Recognition-Flutter: Flutter ID Document Recognition SDK for Android and iOS — scan and recognize ID cards, passports, and driver licenses with OCR, MRZ, barcode/QR scanning, live document detection, and automatic capture. On-device, on-premise identity verification.GitHub

How to Run

1

Install tools

Flutter 3.44+ (see the package pubspec.yaml). JDK 17. Run flutter doctor and fix reported issues.

2

Clone and bootstrap

git clone https://github.com/Faceplugin-ltd/ID-Document-Recognition-Flutter.git
cd ID-Document-Recognition-Flutter
dart run tool/bootstrap.dart

3

Place native runtimes

Platform	File	Example app path	Your own app path
Android	documentreadersdk.aar	example/android/libdocsdk/	Plugin android/libs/
iOS	docsdk.framework	ios/Frameworks/	Plugin ios/Frameworks/

• Android Google Drive: documentreadersdk.aar

• iOS Google Drive: docsdk.framework

4

Run the example

cd example
flutter pub get
flutter run

Physical phone. Keep Android com.faceplugin.documentreader, iOS com.faceplugin.documentreader.app.

License

Licenses are offline. Request a new license key for your own app.

Integrate into your own app

dependencies:
  document_reader_sdk:
    git:
      url: https://github.com/Faceplugin-ltd/ID-Document-Recognition-Flutter.git

Then flutter pub get, copy runtimes, cd ios && pod install, and rebuild the native app.

import 'package:document_reader_sdk/document_reader_sdk.dart';

Future<void> boot() async {
  final machine = await getMachineCode(); // machine code
  final act = await setActivation('license key');
  if (act != sdkSuccess) {
    print(await lastLicenseError());
    return;
  }
  final code = await init();
  if (code != sdkSuccess) return;

  final locateJson = await locateDocument(imagePath);
  final resultJson = await recognize(frontPath, backPath, true);
}

Authenticity accepts true / false or 'normal' / 'none'. Image input: file path, file:// URI, content URI, or base64 / data: URL.

APIs

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

setActivation: This API is used to activate the SDK

Future<int> setActivation(String license)

init: This API is used to initialize the SDK

Future<int> init()

getMachineCode: This API is used to retrieve the machine code

Future<String> getMachineCode()

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

Future<String> locateDocument(ImageInput image)

recognize: This API is used to run FullProcess

Future<String> recognize(ImageInput front, [ImageInput? back, Object authenticity = true])

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

Future<String> documentRecognition(ImageInput front, [ImageInput? back])

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

Future<String> documentLiveness(ImageInput front, [ImageInput? back])

Also: getLicenseStatus, startNewSession, recognizeResult (typed DocResult), deinit.

Request a License & Support · Contact us

FAQ

Package? document_reader_sdk.

Passport OCR? Yes. recognize / documentProcess. Typed helper: recognizeResult.

Related documentation

• Faceplugin ID Document Recognition Mobile SDK · React Native · Glossary

• Face Recognition Flutter SDK

• Document result JSON

• Request a License · Status codes

• Combining products (eKYC) · SDK comparison