FaceAuthenticator #

Incorporate facial authentication with proof of life verification and fingerprint authentication technology into your Flutter application. This integration is ideal for enhancing login flows and securing

Requirements #

Flutter	Version
Flutter	1.20+
Dart	2.15+

Android	Version
minSdk	21
compileSdk	33

iOS	Version
iOS Target	12.0
Xcode	14.3.1+
Swift	5.3.2+

Sending your app to Play Store

To publish your app on the Google Play Store, you must complete a data safety form. Since we integrate with the FingerPrintJS SDK, you'll need to provide the following information:

Question in Google Play Console's data safety form	Response
Does your app collect or share any of the required user data types?	Yes.
What type of data is collected?	Device or other identifiers.
Is this data collected, shared, or both?	Collected.
Is this data processed ephemerally?	Yes.
Why is this user data collected?	Fraud Prevention, Security, and Compliance.

Runtime permissions #

Android #

Permission	Reason	Required
`CAMERA`	Capturing the selfie in policies with facial re-authentication	Yes

iOS #

Permission	Reason	Required
`Privacy - Camera Usage Description`	Capturing the selfie in live facial verification policies	Yes

Platform Configurations #

Android #

If your version of Gradle is earlier than 7, add these lines to your build.gradle.

allprojects {
  repositories {
    ...
    maven { url 'https://repo.combateafraude.com/android/release' }
    maven { url 'https://raw.githubusercontent.com/iProov/android/master/maven/' }
    maven { url 'https://maven.fpregistry.io/releases' }
    maven { url 'https://jitpack.io' }
  }
}

If your version of Gradle is 7 or newer, add these lines to your settings.gradle.

dependencyResolutionManagement {
  repositories {
    ...
    maven { url 'https://repo.combateafraude.com/android/release' }
    maven { url 'https://raw.githubusercontent.com/iProov/android/master/maven/' }
    maven { url 'https://maven.fpregistry.io/releases' }
    maven { url 'https://jitpack.io' }
  }
}

Add support for Java 8 to your build.gradle file. Skip this if Java 8 is enabled.

android {
    ...
    compileOptions {
        sourceCompatibility JavaVersion.VERSION_1_8
        targetCompatibility JavaVersion.VERSION_1_8
    }
}

iOS #

In the info.plist file, add the permissions below:

<key>NSCameraUsageDescription</key>
<string>To capture the selfie</string>

Usage #

Parameter	Required
`mobileToken`: Usage token associated with your CAF account	Yes
`personId`: User identification that registers the user's face for face matching. Currently, this value only accepts the user's CPF.	Yes

FaceAuthenticator faceAuthenticator =
        FaceAuthenticator(mobileToken: mobileToken, personId: personId);

// Set the SDK configuration options here before call .start()

final stream = faceAuthenticator.start();
    stream.listen((event) {
      if (event is FaceAuthenticatorEventConnecting) {
        // The SDK is connecting to the server. You should provide an indeterminate progress indicator
        // to let the user know that the connection is taking place.
      } else if (event is FaceAuthenticatorEventConnected) {
        // The SDK has connected, and the iProov user interface will now be displayed. You should hide
        // any progress indication at this point.
      } else if (event is FaceAuthenticatorEventClosed) {
        // The user canceled face verification, either by pressing the close button at the top of the screen, or sending
        // the app to the background.
      } else if (event is FaceAuthenticatorEventSuccess) {
        // The user was successfully verified/enrolled and the token has been validated.
        // You can access the following properties:
        final signedResponse = event.signedResponse;
      } else if (event is FaceAuthenticatorEventFailure) {
        // The user was not successfully verified/enrolled, as their identity could not be verified,
        // or there was another issue with their verification/enrollment (e.g. lost internet connection).
        // You can access the following properties:
        final errorType = event.errorType
        final errorDescription = event.errorDescription
      }
    });