Face Authentication

Download OpenAPI specification:Download

Manage the face authentication sessions that are used to securely verify the identity of your customers by biometrically matching a selfie to a known image of the user.

Create session

Creates a new face authentication session that will provide a secure context to the process. It returns a device session ID that will be used when initiating the authentication process from the client side. This should be called from the backend.

SecurityHTTP: verify_access_token
Request
Request Body schema: application/json
required
required
RawImage (object)
use_case
string
Default: "login"

Use case for the face authentication flow. Will be used in the future for per use case configurations.

Enum: "login" "credentials-recovery" "step-up"
Responses
200
post/api/v1/face-auth
Request samples
application/json
{
  • "reference": {
    },
  • "use_case": "login"
}
Response samples
application/json
{
  • "session_id": "string",
  • "device_session_id": "string"
}

Get result

Retrieves the result of the face authentication session, which indicates if the user-provided selfie matches the reference image. This should be called from the backend.

SecurityHTTP: verify_access_token
Request
path Parameters
dsid
required
any
Responses
200
get/api/v1/face-auth/{sid}/result
Request samples 
Response samples 
application/json
{
  • "status": "pending",
  • "recommendation": "ALLOW"
}