> For the complete documentation index, see [llms.txt](https://docs.caf.io/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.caf.io/caf-sdk/android/standalone-modules/deprecated-sdks/faceauthenticator-deprecated.md).
# FaceAuthenticator (Deprecated)
## **SDK size**
A maximum of about 3.8 MB, which may decrease because of [these elements](https://github.com/combateafraude/public-docs/blob/docs-sdks/android/reduce-sdks-size.md).
## **Analytics**
Our SDKs by default [collect information](https://github.com/combateafraude/public-docs/blob/docs-sdks/analytics.md) about the user and running environment to better map fraudsters and understand their behaviors. We recommend keeping this collection active as the only purpose of this data is for fraud reduction, but if you wish, you can disable it by **`.setAnalyticsSettings(boolean useAnalytics)`** parameter.
## **Runtime permissions**
| Permission | Reason | Required |
| ------------ | -------------------------- | -------- |
| **`CAMERA`** | To capture the user selfie | Yes |
## Instantiating the SDK
First, create an object of type **`FaceAuthenticator`**. This object is for you to configure all your business rules for the SDK:
```java
FaceAuthenticator mFaceAuthenticator = new FaceAuthenticator.Builder(String mobileToken)
// see table below
.build();
```
> All parameters annotated with `@Nullable` can be given `null` values, useful if you want to set only one of the parameters of a single method.
### **Builder method**
| Parameter | Required |
| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| String mobileToken
Usage token associated with your CAF account.
| Yes. |
| .setPeopleId(String peopleId)
User identifier to perform facematch. Currently, this value accepts only the user's CPF.
| Yes. |
| .setAnalyticsSettings(boolean useAnalytics)
Enables/disables data collection for analytics.
| No, the default is **`true`** |
| .setStabilitySensorSettings(@Nullable SensorStabilitySettings sensorStabilitySettings)
Changes the default settings of the stability sensor. Apply null if you don't want to use this sensor.
| No. The default time is 1000 ms and the default threshold is 0.7 m/s². |
| .setCaptureSettings(@Nullable CaptureSettings captureSettings)
Defines the capture settings. The method accepts instances of the ImageCapture and VideoCapture classes.
| No. The default is **`ImageCapture`** |
| .setLayout(@Nullable @LayoutRes Integer layoutId)
Replaces the default SDK layout. Create a file in your project's layout folder, copy this template and make the desired changes.
| No. The default is [this](https://gist.github.com/murilofank/6984a34e8a7fc8975283b746809e8b7f) |
| .setMask(@DrawableRes Integer greenMask, @DrawableRes Integer whiteMask, @DrawableRes Integer redMask)
Changes the face capture masks: SUCCESS, NORMAL, and FAIL, in that order. If you use this option, use masks with the same detection area as the face, this region is very important for the algorithm to capture.
| No. The mask patterns are:
Normal
Success
Fail
|
| .setStyle(@StyleRes int styleResourceId)
Replaces the SDK's default style. In your project's styles.xml file, copy this template and edit it.
| No. The default is [this](https://gist.github.com/murilofank/3ac0f921435466fd4e0b04d683597a38) |
| .enableSwitchCameraButton(boolean enable)
Enables/disables the button for the user to switch between the front and rear camera.
| No. The default is **`true`** |
| .setNetworkSettings(int requestTimeout)
Sets the timeout interval for SDK requests.
| No. The default is 60 (seconds) |
| .enableGoogleServices(boolean enable)
Allows you to enable/disable features of the SDK that consume GoogleServices in the SDK, we do not recommend disabling the services because of the loss of security.
| No. The default is **`true`** |
| .setUseEmulator(boolean use)
Enables the use of emulators when true. When true, ADB mode is enabled together for the emulator to work correctly. It is not recommended to enable this option, use it for testing purposes only.
| No. The default is **`false`** |
| .setUseRoot(boolean use)
Allows the use of root devices when true.
| No. The default is **`false`** |
| .setUseDeveloperMode(boolean use)
Enables the use of developer mode when true. It is not recommended to enable this option, use it only for testing purposes.
| No. The default is **`false`** |
| .setUseAdb(boolean use)
Enables Android Debug Bridge (ADB) debugging mode when true. It is not recommended to enable this option, use it only for testing purposes.
| No. The default is **`false`** |
| .setUseDebug(boolean use)
Allows you to use the app in debug mode when true. It is not recommended to enable this option, use it only for testing purposes.
| No. The default is **`false`** |
| .setAudioSettings(boolean use)
Enables/disables playback of SDK audios.
| No. The default is **`true`** |
| .setAudioSettings(Integer audioResId)
It allows you to customize the audio used by the SDK.
| No. The default is "Registro Facial". |
| .enableBrightnessIncrease(boolean enable)
Enables/disables the brightness increment of the device on opening the SDK.
| No. The default is **`true`** |
| .setEyesClosedSettings(boolean enable, double threshold)
Allows you to customize the SDK's open-eye validation settings. The method expects as parameter enable to enable or disable validation, and threshold, value between 0.0 and 1.0Allows you to customize the SDK's open-eye validation settings. The method expects as parameter enable to enable or disable validation, and threshold, value between 0.0 and 1.0
| No. The default is **`true`** and **`0.5`** |
| .setStage(CafStage stage)
Allows you to choose the environment in wich the SDK will run (production, beta). The method takes as parameter an enum CafStage to select the environment:
| No. The default is **`CafStage.PROD`** |
| **Enum** | **Description** |
| **`CafStage.PROD`** | Will use the Trust Platform **production** environment to register the SDK executions. |
| **`CafStage.BETA`** | Will use the Trust Platform **beta** environment to register the SDK executions. |
{% hint style="warning" %}
Each environment (beta and production) requires its own specific mobileToken, generated in the Trust platform of the respective environment.
{% endhint %}
### **Security validations**
We are constantly taking actions to make the product more and more secure, mitigating a number of attacks observed in the capture process and, consequently, reducing as many possible identity frauds as possible. The SDK has some blocks that may prevent its execution in certain contexts. To disable them, you can use the methods as shown in the example below:
```java
FaceAuthenticator.Builder("mobileToken")
.setUseEmulator(true)
.setUseRoot(true)
.setUseDeveloperMode(true)
.setUseAdb(true)
.setUseDebug(true)
.build();
```
{% hint style="warning" %}
Disabling security validations is recommended for **testing purposes only**. For publishing your application in production, we recommend using the default settings.
{% endhint %}
## **Starting Activity**
After creating the **`FaceAuthenticator`**, start the **`FaceAuthenticatorActivity`** by passing this object as a parameter via extra intent:
```java
Intent mIntent = new Intent(context, FaceAuthenticatorActivity.class);
mIntent.putExtra(FaceAuthenticator.PARAMETER_NAME, mFaceAuthenticator);
startActivityForResult(mIntent, REQUEST_CODE);
```
## **Getting the result**
To get the **`FaceAuthenticatorResult`** object, which contains the captures taken by the SDK, override the **`onActivityResult`** method in the same activity that you started the **`FaceAuthenticatorActivity`**:
```java
@Override
protected void onActivityResult(int requestCode, int resultCode, Intent data) {
if (requestCode == REQUEST_CODE) {
if (resultCode == RESULT_OK && data != null) {
FaceAuthenticatorResult mFaceAuthenticatorResult = (FaceAuthenticatorResult) data.getSerializableExtra(FaceAuthenticatorResult.PARAMETER_NAME);
// verifique mFaceAuthenticatorResult.getSDKFailure() para descobrir qual foi o motivo da finalização do SDK
} else {
// o usuário fechou a activity
}
}
super.onActivityResult(requestCode, resultCode, data);
}
```
### FaceAuthenticatorResult
| Parameter | Allow null |
| -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------- |
| boolean authenticated
Flag that indicates whether the captured selfie passed face match with the photo stored on the CAF server and the respective CPF entered by the user.
| No |
| String signedResponse
Signed response from the CAF server that performed the facematch. Use this parameter if you want an extra layer of security, checking that the signature of the response is not broken, or caused by an intercepted request. If it is broken, there is a strong indication of request interception.
| Yes, in case of error |
| String trackingId
Identifier of this execution on our servers. If possible, save this field and send it along to our API. This way we will have more data on how the user behaved during the execution.
| Yes, if the user sets **`useAnalytics = false`** or the analytics calls do not work |
| SDKFailure sdkFailure
Object that tells you the reason for the SDK shutdown. For more information, see here.
| Yes, in case of success |
| lensFacing: Int
Defines the face of the camera that was used. Use FaceAuthenticatorResult.LENS\_FACING\_FRONT or FaceAuthenticatorResult.LENS\_FACING\_FRONT to validate.
| No |
---
# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.
## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.
Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter:
```
GET https://docs.caf.io/caf-sdk/android/standalone-modules/deprecated-sdks/faceauthenticator-deprecated.md?ask=&goal=
```
`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.
Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.