flutter_smartface

Flutter plugin for integrating SmartFace Mobile license bootstrap, enrollment, identification, liveness, and hosted flows on Android and iOS.

Plugin Flutter para integrar bootstrap de licença, cadastro, identificação, liveness e hosted flows do SmartFace Mobile em Android e iOS.

Language guide

English is the primary language of this page.

PT-BR: esta página usa inglês como idioma principal e mantém resumos de apoio em português do Brasil.

What This Package Covers

• License login, product lookup, and installation through FlutterSmartfaceLicensePlatform.
• Flutter-owned biometric widgets through FlutterSmartfaceMobilePlatform.
• Native hosted flows through SmartfaceHostedFlow.
• Enrollment without server push through FlutterSmartfaceEnrollerPlatform.
• Camera control and ellipse overlay helpers for custom Flutter layouts.

Integration Sequence

1. Add the dependency to your Flutter application.
2. Provide the native SmartFace binaries required by Android and iOS.
3. Authenticate and install the product license.
4. Configure API credentials.
5. Choose one integration style: hosted native flow, Flutter widget, or activity-based API.

PT-BR

Sequência recomendada: adicionar a dependência, disponibilizar os binários nativos, autenticar e instalar a licença, configurar as credenciais da API e então escolher o estilo de integração mais adequado.

dependencies:
  flutter_smartface: ^0.8.3

final license = FlutterSmartfaceLicensePlatform.instance;
final mobile = FlutterSmartfaceMobilePlatform.instance;

await license.setLogin('license-user', 'license-password');
await license.install(id: 'product-id');

await mobile.setCredentials(
  user: 'api-user',
  password: 'api-password',
  clientIdentifier: 123,
);

final ready = await mobile.apiConfigured();

Choose The Right API

Integration style	Main API	Use when
Hosted native UX	SmartfaceHostedFlow	You want the fastest integration and are comfortable with native-managed screens.
Flutter-owned capture UI	identifyWidget, enrollWidget, enrollWithoutServerPushingWidget, livenessWidget	You need Flutter layout control while keeping SmartFace capture natively rendered.
Activity-based API	smartfaceIdentifyActivity, smartfaceEnrollActivity, liveness	You need lower-level orchestration or compatibility with an existing native flow.

PT-BR

Use hosted flows para integração mais rápida, widgets quando a tela Flutter precisa controlar o layout, e activities quando a orquestração precisa ficar mais próxima do lado nativo.

Native Prerequisites

• Android requires the SmartFace .aar distributed separately to the consuming app.
• iOS requires the SmartFace .xcframework bundles distributed separately to the consuming app.
• The example application in example/ is the most complete validated integration reference in this repository.

Documentation

• API reference: pub.dev/documentation/flutter_smartface/latest/
• Overview: pub.dev/documentation/flutter_smartface/latest/topics/Overview-topic.html
• Integration: pub.dev/documentation/flutter_smartface/latest/topics/Integration-topic.html
• License and Setup: pub.dev/documentation/flutter_smartface/latest/topics/License%20and%20Setup-topic.html
• Biometric Flows: pub.dev/documentation/flutter_smartface/latest/topics/Biometric%20Flows-topic.html
• UI and Camera: pub.dev/documentation/flutter_smartface/latest/topics/UI%20and%20Camera-topic.html

PT-BR

As páginas acima passam a ser a referência pública principal em inglês, com suporte em português do Brasil no próprio conteúdo.

Notes

• The native SmartFace SDK manual and this Flutter package API are related but not equivalent; the package source is the authoritative reference for this plugin.
• Legacy repository guides still exist for maintainers, but the pub.dev pages above are the intended entry point for integrators.

Libraries

Overview

Overview

flutter_smartface_base

Core building blocks shared by the public SmartFace Flutter APIs.

flutter_smartface_camera_controller

Camera controller exposed by SmartFace widget builders.

flutter_smartface_enroller

Enrollment APIs focused on flows without immediate server push.

flutter_smartface_hosted_flow

Native hosted flows for identification and enrollment.

flutter_smartface_license

License, product, and installation APIs for SmartFace Flutter integrations.

flutter_smartface_mobile

Main SmartFace Flutter API for biometric operations.

flutter_smartface_transparent_ellipse_overlay_widget

SmartFace enrollment overlay with an ellipse cutout and automatic visual feedback.

Integration

Integration

flutter_smartface_base

Core building blocks shared by the public SmartFace Flutter APIs.

flutter_smartface_mobile

Main SmartFace Flutter API for biometric operations.

License and Setup

License and Setup

flutter_smartface_license

License, product, and installation APIs for SmartFace Flutter integrations.

flutter_smartface_mobile

Main SmartFace Flutter API for biometric operations.

Biometric Flows

Biometric Flows

flutter_smartface_enroller

Enrollment APIs focused on flows without immediate server push.

flutter_smartface_hosted_flow

Native hosted flows for identification and enrollment.

flutter_smartface_mobile

Main SmartFace Flutter API for biometric operations.

UI and Camera

UI and Camera

flutter_smartface_base

Core building blocks shared by the public SmartFace Flutter APIs.

flutter_smartface_camera_controller

Camera controller exposed by SmartFace widget builders.

flutter_smartface_mobile

Main SmartFace Flutter API for biometric operations.

flutter_smartface_transparent_ellipse_overlay_widget

SmartFace enrollment overlay with an ellipse cutout and automatic visual feedback.