Flutter

Faceplugin Face Recognition Flutter SDK. On-premise 1:1 and 1:N matching with 2D liveness. face_recognition_sdk plugin for Android and iOS.

Fully on-premise Face Recognition SDK for Flutter. Package: face_recognition_sdk. Same native engines as the Android and iOS Face Recognition SDKs.

All processing stays on the device. No biometric data is sent to Faceplugin cloud.

Code

GitHub - Faceplugin-ltd/FaceRecognition-Flutter: Face Recognition, Face Liveness Detection, Face Anti-Spoofing, Face Detection, Face Landmarks, Face Compare, Face Matching, Face Pose, Face Expression, Face Attributes, Face Templates Extraction, Face LandmarksGitHub

How to Run

1

Install tools

Flutter 3.44+ and Dart 3.3+ (from the package pubspec.yaml), JDK 17+ for Android. Run flutter doctor and fix reported issues. Accept Android licenses: flutter doctor --android-licenses. JAVA_HOME must point to the JDK home (the folder that contains bin), not to bin itself.

2

Clone and bootstrap

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

3

Place native runtimes

Platform	File	Example app path	Your own app path
Android	facerecognitionsdk.aar	example/android/libfacesdk/	Copy example/android/libfacesdk/ into your app android/libfacesdk/ and include(":libfacesdk")
iOS	three frameworks	ios/Frameworks/	Plugin checkout ios/Frameworks/

• Android Google Drive: facerecognitionsdk.aar

• iOS Google Drive: frameworks (facerecognitionsdk, FaceRecognitionEngine, onnxruntime)

Do not implementation(files(…aar)) inside the plugin — AGP will fail bundleDebugAar. Copy the libfacesdk module from the example into your app.

On a Mac after placing iOS frameworks: dart run tool/bootstrap.dart (builds matching .xcframeworks) then cd example/ios && pod install. CocoaPods links the .xcframeworks into the plugin pod — plain .framework alone often leaves undefined FaceRecognitionSDK symbols under use_frameworks!.

4

Run the example

cd example
flutter run

Physical phone. Wait for the home status bar → Ready.

Keep demo ids so the included license works:

Platform	Id
Android package name	com.faceplugin.facerecognitionsdk
iOS bundle identifier	com.faceplugin.facerecognition.app

Requirement	Value
Flutter	3.44+ (see pubspec.yaml)
Android	minSdk 24, physical device recommended
iOS	iOS 13+, physical device recommended

Demo tiles: Enroll, Identify, Capture, Attribute, Settings, About.

Screenshots

The gallery is Android sample UI from faceplugin-assets. The Flutter plugin wraps the same native engines; there is no separate Flutter photoshoot in these docs.

Home	Identify	Capture

License

Licenses are offline. Demo keys live in example/lib/core/constants/license.dart. Request a new license key for your own app.

Default thresholds in the example Settings: identify 0.67, liveness 0.5, pose 40°, eye-close 0.5. You pass these as Dart parameters — change them for your product.

Request a License & Support.

Integrate into your own app

You need the Flutter plugin + native runtimes. You do not need the example UI or person database.

dependencies:
  face_recognition_sdk:
    git:
      url: https://github.com/Faceplugin-ltd/FaceRecognition-Flutter.git

Then copy runtimes (table above), set your Android package name / iOS bundle identifier, add camera + photo-library permissions, and request a license for your own app.

import 'package:face_recognition_sdk/face_recognition_sdk.dart';

Future<void> activate() async {
  final code = await getMachineCode(); // machine code — send when requesting a key
  final act = await setActivation('license key');
  if (act != sdkSuccess) {
    throw StateError(await lastLicenseError());
  }
  final initCode = await init();
  if (initCode != sdkSuccess) {
    throw StateError('init failed: $initCode');
  }
}

Future<void> enrollStill(String imagePath) async {
  final faces = await faceDetection(imagePath);
  if (faces.length != 1) return;
  final template = await templateExtraction(imagePath, faces.first);
  final cropB64 = await cropFace(imagePath, faces.first);
  // Store template + crop in YOUR database
}

Optional oval UI: FaceCapture from package:face_recognition_sdk/capture.

APIs

import 'package:face_recognition_sdk/face_recognition_sdk.dart';

Call order: getMachineCode → setActivation → init → detect / VideoWorker → deinit.

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()

faceDetection: This API is used to detect faces

Future<List<FaceBox>> faceDetection(String imageUri, [FaceDetectionParam param])

Boxes include geometry (x1,y1,x2,y2), pose, liveness / quality / eyes / occlusion, age / gender / emotion / mask / glasses, optional attributes, and landmarks + landmarkCount.

templateExtraction: This API is used to extract face template

Future<String> templateExtraction(String imageUri, FaceBox faceBox)

similarity: This API is used to calculate similarity between two templates

Future<double> similarity(String feature1B64, String feature2B64)

detect: This API is used to detect faces and return engine JSON

Future<String> detect(ImageInput image, {bool crop = false, int flags = DETECT_ALL})

Also: extractFeature, quality, cropFace, setLandmarkMode / getLandmarkMode, getLicenseStatus, lastLicenseError, deinit.

VideoWorker: This API is used for live 1:N identify

Future<int> startVideoWorker(VideoWorkerConfig config)
Future<int> syncVideoWorkerDatabase(List<String> features, {double matchThreshold = 0.67})
Future<LiveFrameResult> ingestLiveCameraFrame(LiveCameraPhoto photo, LiveFrameOptions options)
Stream<String> get videoWorkerEvents
Future<void> stopVideoWorker()

Request a License & Support · Contact us

FAQ

Package? face_recognition_sdk.

Screenshots? The gallery uses Android sample UI. The plugin wraps native Android and iOS engines.

Face Liveness Flutter SDK? None public.

Related documentation

• Faceplugin Face Recognition Mobile SDK · React Native · Glossary

• ID Document Recognition Flutter SDK

• There is no public Face Liveness Flutter SDK — use Identify 2D liveness or native Android/iOS Liveness.

• Request a License · Status codes

• Combining products (eKYC) · SDK comparison