FaceAuthenticator (Deprecated)
Plugin that calls native SDKs in Android and iOS.
Settings
In the file ROOT_PROJECT/android/app/build.gradle
, add:
Import the package and call the add() method inside the initialization in android/app/src/main/java/io/ionic/starter/MainActivity.java
:
Importing
Using
General customizations
FaceAuthenticator |
---|
CPF of the user who is using the plugin to be used for fraud detection via analytics |
Enables/disables data collection for maximizing anti-fraud information. Default is true. |
Enables/disables sounds. Default is true. |
Change the default network settings. The default is 60 seconds |
Customizations only applied on Android |
customizations only applied on iOS |
Define the capture settings |
CaptureMode |
---|
Configura a captura por vídeo |
Configura a captura por foto |
Example of use
Getting the result
The FaceAuthenticator return object will have the result
attribute that contains a string SUCCESS
, FAILURE
or CLOSED
. The return will default to PassiveFaceLivenessSuccess
, PassiveFaceLivenessFailure
, and PassiveFaceLivenessClosed
, respectively, for each of the cases.
FaceAuthenticatorSuccess
Field | Description |
---|---|
| Full address of the image on the device |
| Signed response from the CAF server which confirmed that the captured selfie has a real face (not a photo or video). Use this parameter if you want an extra layer of security by checking that the signature of the response is not broken, caused by an intercepted request. If it is broken, there is a strong indication of request interception |
| 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. Will be null if the user sets useAnalytics = false or the analytics calls do not work |
FaceAuthenticatorFailure
Field |
---|
Friendly message explaining why the SDK failed |
Fault type that shut down the SDK |
Os tipos de falha existentes são:
Field | Description |
---|---|
| When the token entered is invalid. Should not occur in a production environment. |
| some mandatory permission was not granted by the user. It will only happen in a production environment if your app does not ask your user or the user manually disables it before starting. |
| Server connection failure. Will occur in production if the user's device is without internet. |
| Failure in some request with our servers. It will occur in production only in case of our failure. |
| When the device is not safe to run the SDK. If this failure occurs, let us know. |
| When the device does not have enough space for capturing some of the photos. Can occur in production. |
| some internal failure made it impossible to run the SDK. It may occur due to project configuration errors, it should not occur in production. |
FaceAuthenticatorClosed
Empty object indicating closure of the capture screen by the user.
Last updated