FaceAuthenticator

We recommend you to check this documentation in pub.dev to get more examples and extra information.

Privacy Policy and Terms & Conditions of Use

When using our plugin, please make sure that you agree with our Privacy Policy and our Terms and Conditions of Use.

Pre-requirements

Minimum configuration	Version
Flutter	1.12+
Dart	2.12+
Android API	21+
iOS	13.0+

If you use Dart in a version below 2.12, check the compatible version here.

Settings

Android

In the file ROOT_PROJECT/android/app/build.gradle, add:

android {

    ...

    dataBinding.enabled = true

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

    rootProject.allprojects {
        repositories {
            maven { url "https://repo.combateafraude.com/android/release" }
            maven { url 'https://raw.githubusercontent.com/iProov/android/master/maven/' }
        }
    }
}

iOS

In the file ROOT_PROJECT/ios/Podfile, add:

source 'https://github.com/combateafraude/iOS.git'
source 'https://cdn.cocoapods.org/' #

Finally, add the camera permission to the file ROOT_PROJECT/ios/Runner/Info.plist:

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

Using

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

// Your SDK customization parameters

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 errorMessage = event.errorMessage
        final code = event.code
        final signedResponse = event.signedResponse
      }
    });

FaceAuthenticator methods

Parameter	Required
.setStage(String stage) Used to redirect the SDK to the desired environment in caf api.	No
.setFilter(String filter) Used to change the SDK camera filter. It has the following options: CameraFilter.natural or CameraFilter.lineDrawing	No, the default is CameraFilter.lineDrawing
.setEnableScreenshots(bool enable) Used to enable screenshots during the SDK scan.	No, the default is false
.setEnableLoadingScreen(bool enable) Used to determines whether the SDK's loading screen will be implemented through client side or if will be used the default screen. If set to 'true,' the loading screen will be a standard SDK screen. If 'false,' You should provide an indeterminate progress indicator.	No, the default is false
.setImageUrlExpirationTime(String time) Used to set the image URL expiration time.	No, the default is null

Enums

CafStage

Description	Values
Used to set the SDK stage on .setStage(String stage) method.	CafStage.prod, CafStage.beta

CameraFilter

Description	Values
Used to set the SDK's camera filter	CameraFilter.natural, CameraFilter.lineDrawing

Time

Description	Values
Used to set the image URL expiration time.	Time.threeHours, Time.thirtyDays

FaceAuthenticatorSuccess

Field
String signedResponse Signed response from the CAF server confirming that the captured selfie has a real face. This parameter is used to get an extra layer of security, checking that the signature of the response is not broken, or caused by request interception. If it is broken, there is a strong indication of request interception.

signedResponse params

Event	Description
requestId	Request identifier.
isAlive	Validation of a living person, identifies whether the user passed successfully or not.
isMatch	Face match validation result.
token	Request token.
userId	User identifier provided for the request.
imageUrl	Temporary link to the image, generated by our API.
personId	User identifier provided for the SDK.
sdkVersion	Sdk version in use.
iat	Token expiration.
message	Return message.

The isAlive parameter is VERY IMPORTANT, based on this validation, the user can be guided to continue the flow or not. In case of isAlive: true, it would be able to continue with the journey. If isAlive: false, this user is not valid and should be prevented from continuing their journey. Furthermore, the isMatch parameter indicates whether the Face Match passed successfully or not, returning isMatch: true in case of success and false in case of failure.

FaceAuthenticatorFailure

iOS

The FaceAuthenticatorFailure object return the following parameters.

Field
String signedResponse Signed response from the CAF server confirming that the captured selfie has a real face.
String errorType Error type returned by the SDK. Check the table below.
String errorMessage Error message returned by the SDK.
String code Error code returned by the SDK. Check the table below.

In case of failure, the FaceAuthenticatorFailure object will also return a signedResponse containing information. Within the signedResponse, the parameter isAlive defines the execution of liveness, where true is approved and false is rejected.

Code	Error Type	Description
1	unknown	Try aganin
2	getToken	Error while trying to capture the execution token.
3	livenessError	Error while attempting to execute liveness due to communication issues.
4	registerError	Error while performing the registration of the liveness execution.
5	captureAlreadyActive	An existing capture is already in progress. Wait until the current capture completes before starting a new one.
6	cameraPermissionDenied	The user disallowed access to the camera when prompted. You should direct the user to re-try.
7	networkError	An error occurred with the video streaming process. The associated string (if available) will contain further information about the error.
8	serverError	A server-side error/token invalidation occurred. The associated string (if available) will contain further information about the error.
9	unexpectedError	An unexpected and unrecoverable error has occurred. The associated string will contain further information about the error. These errors should be reported to iProov for further investigation.

Android

The FaceAuthenticatorFailure object return the following parameters.

Field
String errorType Error type returned by the SDK. NetworkReason or ServerReason.
String errorMessage Error message returned by the SDK.
String code Error code returned by the SDK.