/
Face Authentication

Face Authentication

Owned by Priit Aavik
Last updated: Mar 27, 2024
2 min read

Table of Contents

Create a new session

  • To start the Web Face Authentication session, the user must receive a link idv.ondato.com/?id=IDV_session_id (custom domain and subdomain can be used if it is configured for the application).

  • For the Mobile and Web SDKs, only the IDV session ID (without URL) is necessary as the parameter to initiate the user session.

In order to get a IDV_session_id you must call IDV API → POST /v1/identity-verifications endpoint.

{ "setupId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "faceAuthentication": { "identityVerificationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6" } }

  • setupId refers to face authentication flow setup

  • identityVerificationId refers to IDV session of KYC identification.

Requirements for eligible IDV sessions

  • KYC status must be approved

  • KYC must be passed with active liveness

  • IDV session must belong to the same application

  • IDV session data must not be deleted

Check session results

To check the outcome of the user's Face Authentication session (once an application callback, URL redirect with IDV session ID, or webhook is received), follow these steps:

Call IDV API → GET /v1/identity-verifications/{id} endpoint with the IDV_session_id that was generated for the user’s session to get a reference to faceAuthentication resource.

... "faceAuthentication": { "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6" } ...

From the previous response, take the id of faceAuthentication to call Face authentication API → GET /v1/face-authentications/{id}.

{ "applicationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "createdUtc": "2023-12-27T10:00:11.054Z", "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "identityVerificationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", "status": "Pending" }

The status property indicates the user’s authentication result.

Possible results:

  • Pending | the authentication was not completed.

  • Failed | the authentication was not successful.

  • Completed | the authentication was successful, and the user has been recognized and matched with the referred identification.

  • MaxAttemptsReached | the authentication was not successful, and the user has reached the maximum number of attempts.

Flows

 

Related content