Face Authentication
Explains how to integrate a face authentication
To perform a face authentication it is required to have already an "Identification" and its verification ID. The process consist in a liveness check of the user and a final check to verify the match with the identification.

  • Create a FaceAuthenticationParams object with authentication information and the verification id you want to verify
  • Start the verification with FaceAuthenticationActivity.startForResult
  • Handle result in onActivityResult method

Please update the below code with your Client ID and Client Secret from your Customer Dashboard.
We suggest to use the token authentication in production environment.
Java
Kotlin
void faceAuthentication(String verificationId) {
FaceAuthenticationParams faceAuthenticationParams = new FaceAuthenticationParamsWithClientSecret(
"< client id >",
"< client secret >",
verificationId
R.style.AuthenteqThemeBase // optional
);
FaceAuthenticationActivity.startForResult(
activity,
MY_REQUEST_FACEAUTH_CODE,
faceAuthenticationParams
);
}
@Override
protected void onActivityResult(int requestCode, int resultCode, @Nullable Intent data) {
if (requestCode == MY_REQUEST_FACEAUTH_CODE) {
if (resultCode == RESULT_OK) {
String code = FaceAuthenticationActivity.getResult(data);
// Check face authentication result with the CODE provided
} else {
Throwable throwable = FaceAuthenticationActivity.getError(data);
// Handle error
} else {
super.onActivityResult(requestCode, resultCode, data);
}
}
}
fun faceAuthentication(verificationId: String) {
val faceAuthenticationParams = FaceAuthenticationParamsWithClientSecret(
"< client id >",
"< client secret >",
verificationId
)
FaceAuthenticationActivity.startForResult(
this,
MY_REQUEST_FACEAUTH_CODE,
faceAuthenticationParams
)
}
override fun onActivityResult(requestCode: Int, resultCode: Int, data: Intent?) {
if (requestCode == MY_REQUEST_FACEAUTH_CODE) {
if (resultCode == Activity.RESULT_OK) {
FaceAuthenticationActivity.getResult(data)?.let { code ->
// Check face authentication result with the CODE provided
}
} else {
FaceAuthenticationActivity.getError(data)?.let { error ->
// Handle error
}
}
} else {
super.onActivityResult(requestCode, resultCode, data)
}
}
Authentication Token can be obtained with face authentication API and then specified with the FaceAuthenticationParams as the following code:
Java
Kotlin
void faceAuthentication(String verificationId) {
FaceAuthenticationParams faceAuthenticationParams = new FaceAuthenticationParamsWithToken(
"< client id >",
"< token >",
verificationId
R.style.AuthenteqThemeBase // optional
);
FaceAuthenticationActivity.startForResult(
activity,
MY_REQUEST_FACEAUTH_CODE,
faceAuthenticationParams
);
}
fun faceAuthentication(verificationId: String) {
val faceAuthenticationParams = FaceAuthenticationParamsWithToken(
"< client id >",
"< token >",
verificationId
)
FaceAuthenticationActivity.startForResult(
this,
MY_REQUEST_FACEAUTH_CODE,
faceAuthenticationParams
)
}
Authentication token can only be used for a single operation. Always generate a new token before start a new face authentication.

With the code obtained from FaceAuthenticationActivity.getResult it is possible to get the face authentication result using the following API:
get
https://api.app.authenteq.com
/mobile-sdk/face-authentication-result
Obtain the result of a face authentication
When successful the response will contain a single boolean property named success:
{
"success": true
}
Copy link
On this page
Implementation
Example to Start a Face Authentication
Get Face Authentication Result
get
Obtain the result of a face authentication