SDKs response

This page explains the reasons why an SDK is terminated. To do this, check the instance of the SDKFailure object class present in the result object.

InstanceOf	Description	Example	Present SDKs
null	The SDK was closed successfully. Your return objects are correctly filled in.	When the user successfully executes the internal steps	DocumentDetector PassiveFaceLiveness FaceAuthenticator
InvalidTokenReason	The token entered is not valid for the corresponding product	Parameterize "test123" as token in the SDK builder	DocumentDetector PassiveFaceLiveness FaceAuthenticator
PermissionReason	You are missing some mandatory permission to run the SDK	Start DocumentDetector without camera permission granted	DocumentDetector PassiveFaceLiveness FaceAuthenticator AddressCheck
AvailabilityReason	The SDK is not yet available for use. The variable SDKFailure.getMessage() contains instructions for the user	The device's internal storage is full when installing the app, and the face detection template cannot be installed together	PassiveFaceLiveness FaceAuthenticator
NetworkReason	Internet connection failure	User was without internet during facematch in FaceAuthenticator	DocumentDetector PassiveFaceLiveness FaceAuthenticator AddressCheck
ServerReason	When an SDK request receives a status code of failure	In theory, it shouldn't happen. If you see something like this, let us know!	DocumentDetector PassiveFaceLiveness FaceAuthenticator AddressCheck
SecurityReason	When the SDK cannot be started due to a security reason	When Google Security Provider is not updating	DocumentDetector PassiveFaceLiveness FaceAuthenticator
StorageReason	There is no space on the user device's internal storage	When there is no space on the internal storage while capturing the document photo	DocumentDetector PassiveFaceLiveness FaceAuthenticator
LibraryReason	When an SDK internal library cannot be started	Forgetting to set theCompress configuration will lead to this failure in the DocumentDetector	DocumentDetector
InvalidFaceReason	There is no face record for the given peopleId	When the user authenticates with a peopleId that has no face record	FaceAuthenticator

Example

The following example shows how to discover and handle the shutdown reason for the DocumentDetector SDK:

@Override
protected void onActivityResult(int requestCode, int resultCode, Intent data) {
    if (requestCode == REQUEST_CODE){
        if (resultCode == RESULT_OK && data != null){
            DocumentDetectorResult mDocumentDetectorResult = (DocumentDetectorResult) data.getSerializableExtra(DocumentDetectorResult.PARAMETER_NAME);
            SDKFailure sdkFailure = mDocumentDetectorResult.getSDKFailure();
            if (sdkFailure == null){ // ou sdkFailure == null
                // the SDK has closed successfully
            } else if (sdkFailure instanceof InvalidTokenReason){
                // the token entered as a parameter is not valid, please revise it
            } else if (sdkFailure instanceof PermissionReason){
                // permission must be granted by the user to start the SDK
            } else if (sdkFailure instanceof AvailabilityReason){
                // the String sdkFailure.getMessage() contains instructions to the user
            } else if (sdkFailure instanceof NetworkReason){
                // internet connection failure
            } else if (sdkFailure instanceof ServerReason){
                // there was a problem in any communication with the CAF servers, let us know!
            } else if (sdkFailure instanceof SecurityReason){
                // some security reason on the user's device prevents the use of the SDK
            } else if (sdkFailure instanceof StorageReason){
                // ask your user to free up internal storage space
            } else if (sdkFailure instanceof LibraryReason){
                // some internal library encountered problems running
            }
        } else {
        // the user closed the activity
        }
    }
    super.onActivityResult(requestCode, resultCode, data);
}

Security returns

We are constantly taking actions to make the product more and more secure, mitigating many attacks observed in the capture processes and, consequently, reducing as many possible identity frauds as possible. The errors described here are returned in the message field of the SecurityReason class.

Error 100

Represents SDK blocking emulated devices.

The use of emulators is very common by fraudsters nowadays, because of the possibility to access any existing device, opening a huge range of possibilities for new frauds. Because of this, by default, the SDKs perform this blocking.

If you want to disable this validation, use the .setUseEmulator(bool use) method in the SDK Builder.

Error 200

Represents the blocking of devices with root privileges by the SDK.

The use of root devices is the main means of fraud today, because of the possibility of accessing a device with extra privileges, allowing the fraudster to access hidden properties, as well as the possibility of modifying and circumventing the entire security system behind the SDKs. Because of this, by default, the SDKs perform this blocking.

If you want to disable this validation, use the .setUseRoot(bool use) method in the SDK Builder.

Error 300

Represents the locking of devices with developer mode active.

Using devices in developer active mode allows a user to access unique development settings, such as the ability to debug applications using USB cables. Because of this, by default, the SDKs perform this blocking.

If you want to disable this validation, use the method .setUseDeveloperMode(bool use) in the SDK Builder.

Error 400

Represents the locking of devices with Android Debug Bridge enabled.

The ADB command facilitates a variety of device actions, such as installing and debugging apps and provides access to a Unix shell. Because of this, by default, the SDKs perform this locking.

If you want to disable this validation, use the .setUseAdb(bool use) method in the SDK Builder.

Error 500

Represents the locking of devices with debug mode enabled.

Using devices with debug mode enabled allows a user to debug applications using USB cables, allowing them to understand and test different ways to bypass the SDK flow. Because of this, by default, the SDKs perform this blocking.

If you want to disable this validation, use the .setUseDebug(bool use) method in the SDK Builder.

Error 600 (soon)

Represents the blocking of devices with fraudulent app signatures.

Signature verification blocks reverse engineering attacks and all other malicious attacks that can be done after this process in which the app has its original signature changed. Because of this, SDKs perform this blocking by default.

If you want to disable this validation, use the .checkAppSignature(bool use) method in the SDK Builder.