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 |
---|---|
| 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. |
SDK Dependencies
FaceAuthenticator leverages the following external SDKs:
SDK | Version |
---|---|
| 3.1.0 |
FaceLiveness Android: Enables the integration of live facial verification and fingerprint authentication technology.
Transitive dependencies
SDK | Version |
---|---|
| 9.0.4 |
| 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 |
---|---|---|
| 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
.
If your version of Gradle is 7 or newer, add these lines to your settings.gradle
.
Add support for Java 8 to your build.gradle
file. Skip this if Java 8 is enabled.
Add the SDK version to the dependencies section in your build.gradle
file
Instantiating the SDK
First, create an object of type FaceAuthenticator
. This object is for you to configure all your business rules:
Builder method
Parameter | Required |
---|---|
Usage token associated with your Identity account (see how to get it here). | Yes |
Used to redirect the SDK to the desired stage in caf api. The method takes as parameter an enum
| No. The default is |
Used to change the SDK filter, that has the following options:
| No, the default is |
Used to enable screenshots during the SDK scan. Disabled by default for security reasons. | No, the default is |
Used to enable a default loading progressbar during loading events. You can set your customized loading screen instead, using the | No, the default is |
Used to customize the image URL expiration time, that has the following options:
| No, the default is |
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 |
---|---|
User CPF | Yes |
Your app Context | Yes |
Response Listener | Yes |
Example
VerifyAuthenticationListener options
Method | Description |
---|---|
| The execution has ended with success, you have to use the |
| The execution has ended with error, you have to use the |
| The execution has been cancelled by the user. |
| The SDK is loading, you can use this method to set a action in your app, for example a loading. |
| 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 |
---|---|
| 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 |
---|---|
| Request identifier. |
| Validation of a living person, identifies whether the user passed successfully or not. |
| Face match validation result. |
| Request token. |
| User identifier provided for the request. |
| Temporary link to the image, generated by our API. |
| User identifier provided for the SDK. |
| Sdk version in use. |
| Token expiration. |
| 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 |
---|---|
| Error description. |
| Return the type of the error. |
ErrorType
type | Description |
---|---|
| 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. |
| 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. |
| 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. |
| 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. |
| 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