FaceAuthenticator

Enables you to integrate live facial authentication and fingerprint technology into your Android applications, offering a seamless and secure way to authenticate users.

Current Version

Name Version

Name	Version
`FaceAuthenticator`	3.1.0

FaceAuthenticator

3.1.0

Requirements

Minimum Android SDK API version: minSdk 21 (Android 5 Lollipop)
Android SDK API version to compile: compileSdk 34

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.

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.

versionName and versionCode are mandatory for the SDK to work correctly.

SDK Dependencies

FaceAuthenticator leverages the following external SDKs:

SDK Version

SDK	Version
`FaceLiveness`	3.1.0

FaceLiveness

3.1.0

FaceLiveness Android: Enables the integration of live facial verification and fingerprint authentication technology.

Transitive dependencies

SDK Version

SDK	Version
`iProov Biometrics Android`	9.0.4
`Fingerprint Pro Android`	2.3.2

iProov Biometrics Android

9.0.4

Fingerprint Pro Android

2.3.2

iProov Biometrics Android: Enables the integration of live facial verification technology.
Fingerprint Pro Android: Provides fingerprint authentication capabilities to enhance security features in your app.

These dependencies are easily managed through Gradle and are bundled with the SDK for ease of installation.

Runtime permissions

Permission Reason Required

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

CAMERA

Capturing the selfie in policies with facial re-authentication

Yes

Installation

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
    }
}

Add the SDK version to the dependencies section in your build.gradle file

dependencies {
    implementation 'com.combateafraude.sdk:new-face-authenticator:{version}'
}

Instantiating the SDK

First, create an object of type FaceAuthenticator. This object is for you to configure all your business rules:

FaceAuthenticator faceAuthenticator = new FaceAuthenticator.Builder(String mobileToken)
    //see table below
    .build();

Builder method

Parameter Required

Parameter	Required
`String mobileToken` Usage token associated with your Identity account (see how to get it here).	Yes
`.setStage(CAFStage stage)` Used to redirect the SDK to the desired stage in caf api. The method takes as parameter an enum `CafStage` to select the environment: `CAFStage.PROD` set production environment. `CAFStage.BETA` set beta environment.	No. The default is `CAFStage.PROD`
`.setFilter(Filter filter)` Used to change the SDK filter, that has the following options: `Filter.NATURAL` `Filter.LINE_DRAWING`	No, the default is `LINE_DRAWING`
`.setEnableScreenshots(boolean bool)` Used to enable screenshots during the SDK scan. Disabled by default for security reasons.	No, the default is `false`
`.setLoadingScreen(boolean bool)` Used to enable a default loading progressbar during loading events. You can set your customized loading screen instead, using the `onLoading` method below.	No, the default is `false`
`.setImageUrlExpirationTime(Time time)` Used to customize the image URL expiration time, that has the following options: `Time.THREE_HOURS` `Time.THIRTY_DAYS`	No, the default is `null`

String mobileToken

Usage token associated with your Identity account (see how to get it here).

Yes

.setStage(CAFStage stage)

Used to redirect the SDK to the desired stage in caf api. The method takes as parameter an enum CafStage to select the environment:

CAFStage.PROD set production environment.
CAFStage.BETA set beta environment.

No. The default is CAFStage.PROD

.setFilter(Filter filter)

Used to change the SDK filter, that has the following options:

Filter.NATURAL
Filter.LINE_DRAWING

No, the default is LINE_DRAWING

.setEnableScreenshots(boolean bool)

Used to enable screenshots during the SDK scan. Disabled by default for security reasons.

No, the default is false

.setLoadingScreen(boolean bool)

Used to enable a default loading progressbar during loading events. You can set your customized loading screen instead, using the onLoading method below.

No, the default is false

.setImageUrlExpirationTime(Time time)

Used to customize the image URL expiration time, that has the following options:

Time.THREE_HOURS
Time.THIRTY_DAYS

No, the default is null

Consulting a policy

To authenticate a user, use the authenticate() method. You must enter the user's CPF, your app's Context and a VerifyAuthenticationListener object.

Parameters

Parameter Required

Parameter	Required
`String personId` User CPF	Yes
`Context context` Your app Context	Yes
`VerifyAuthenticationListener listener` Response Listener	Yes

String personId

User CPF

Yes

Context context

Your app Context

Yes

VerifyAuthenticationListener listener

Response Listener

Yes

Example

faceAuthenticator.authenticate(Context context, String personId, new VerifyAuthenticationListener() {
    @Override
    public void onSuccess(FaceAuthenticatorResult result) {
        
    }

    @Override
    public void onError(FaceAuthenticatorErrorResult errorResult) {
        
    }

    @Override
    public void onCancel() {
        
    }

    @Override
    public void onLoading() {
        
    }

    @Override
    public void onLoaded() {
        
    }
});

VerifyAuthenticationListener options

Method Description

Method	Description
`onSuccess`	The execution has ended with success, you have to use the `result` and check for the results of the SDK.
`onError`	The execution has ended with error, you have to use the `result` and check for the error results of the SDK.
`onCancel`	The execution has been cancelled by the user.
`onLoading`	The SDK is loading, you can use this method to set a action in your app, for example a loading.
`onLoaded`	The SDK is not loading anymore, you can use this method to set a action in your app, for example, you can stop your previous loading.

onSuccess

The execution has ended with success, you have to use the result and check for the results of the SDK.

onError

The execution has ended with error, you have to use the result and check for the error results of the SDK.

onCancel

The execution has been cancelled by the user.

onLoading

The SDK is loading, you can use this method to set a action in your app, for example a loading.

onLoaded

The SDK is not loading anymore, you can use this method to set a action in your app, for example, you can stop your previous loading.

FaceAuthenticatorResult

Success

Return Reason

Return	Reason
`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.

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

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.

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.

FaceAuthenticationErrorResult

Return Reason

Return	Reason
`String description`	Error description.
`ErrorType errorType`	Return the type of the error.

String description

Error description.

ErrorType errorType

Return the type of the error.

ErrorType

type Description

type	Description
`CAMERA_PERMISSION`	Indicates that the device does not have permission to access the camera. This error typically occurs when the user denies access to the camera or if the app lacks the necessary permissions.
`NETWORK_EXCEPTION`	Indicates a network-related error occurred. This error may occur due to various network issues such as a lack of internet connection, server timeouts, or network congestion.
`SERVER_EXCEPTION`	Indicates an exception occurred on the server-side.<br. />This error is typically returned when there is an issue with the server processing the facial recognition request. This could include server-side errors, misconfigurations, or service interruptions.
`TOKEN_EXCEPTION`	Indicates an issue with the provided token. This error may occur if the provided authentication token is invalid, expired, or lacks the necessary permissions to perform facial recognition tasks.
`UNSUPPORTED_DEVICE`	Indicates that the device is not supported. This error may occur if the device hardware or software does not meet the minimum requirements for facial recognition functionality.

CAMERA_PERMISSION

Indicates that the device does not have permission to access the camera. This error typically occurs when the user denies access to the camera or if the app lacks the necessary permissions.

NETWORK_EXCEPTION

Indicates a network-related error occurred. This error may occur due to various network issues such as a lack of internet connection, server timeouts, or network congestion.

SERVER_EXCEPTION

Indicates an exception occurred on the server-side.<br. />This error is typically returned when there is an issue with the server processing the facial recognition request. This could include server-side errors, misconfigurations, or service interruptions.

TOKEN_EXCEPTION

Indicates an issue with the provided token. This error may occur if the provided authentication token is invalid, expired, or lacks the necessary permissions to perform facial recognition tasks.

UNSUPPORTED_DEVICE

Indicates that the device is not supported. This error may occur if the device hardware or software does not meet the minimum requirements for facial recognition functionality.

Last updated 14 days ago