Liveness

If you wish to request a biometric check from the user, this section will provide you with all the details to complete this. Each check will provide a report of the result from the liveness and face match check.

Here we describe how to:

• Request a liveness check.
• Types of liveness.

You must provide the max number of retries your users can have before the liveness is failed. There must be a minimum of 1 attempt. Yoti recommends 3 attempts as a max retry number.

Request Liveness

Yoti currently provides two types of liveness checks - Static (or Passive) liveness and Zoom (or Active) liveness. We recommended you to use the newer Static liveness that provides a better user experience.

Static Liveness

const livenessCheck = new RequestedLivenessCheckBuilder()

    .forStaticLiveness()

    .withMaxRetries(3)

    .build();

Zoom Liveness

const livenessCheck = new RequestedLivenessCheckBuilder()

    .forZoomLiveness()

    .withMaxRetries(3)

    .build();

An "attempt" is a completed liveness check that is either rejected or approved. If the user does not complete the liveness check, this does not count as an attempt and the user will be prompted to try again.

The liveness check will create a check response for each attempt, so you should ensure liveness has at least one approval.