SDK Settings

POST {{baseurl}}/v2/sdk/identity/liveness/settings

Headers

Name
Type
Description

token*

String

API secret token

Request Body

Field
Type
Description

threshold

String

The security threshold for liveness detection (default is "low").

Default value: low

Allowed values: "low", "mid", "high"

actions

Array

Array of liveness actions, like faceRotation, openMouth, zoom, blink, passive, motion and yesOrNo.

Default value: ["faceRotation"]

randomizeActions

Boolean

Whether to randomize the actions during the session (default is false).

Default value: false

numberofActions

Number

Number of actions to be performed in the session (default is 1).

Default value: 1

actionsDuration

Object

Object specifying duration for each action in seconds.

Default value: null

faceRotation

Number

Duration of the "faceRotation" action in seconds.

openMouth

Number

Duration of the "openMouth" action in seconds.

zoom

Number

Duration of the "zoom" action in seconds.

blink

Number

Duration of the "blink" action in seconds.

yesOrNo

Number

Duration of the "yesOrNo" action in seconds.

motion

Number

Duration of the "motion" action in seconds.

passive

Number

Duration of the "passive" action in seconds.

{
    "threshold": "mid",
    "actions": [
        "faceRotation",
        "openMouth",
        "blink"
    ],
    "randomizeActions": true,
    "numberofActions": 3,
    "actionsDuration": {
        "faceRotation": 5,
        "openMouth": 3,
        "blink": 2
    }
}
{
    "success": true,
    "statusCode": 200,
    "message": "liveness settings updated successfully!",
    "data": {
        "threshold": "high",
        "actions": [
            "faceRotation",
            "openMouth",
            "blink"
        ],
        "randomizeActions": true,
        "numberofActions": 3,
        "actionsDuration": {
            "faceRotation": 5,
            "openMouth": 3,
            "zoom": 0,
            "blink": 2
        },
        "businessId": "62b2e8b281442b03187f7896",
        "createdAt": "2024-09-09T08:24:35.285Z",
        "lastModifiedAt": "2024-09-09T13:08:26.490Z",
        "_createdAt": "2024-09-09T09:24:3535+01:00",
        "_lastModifiedAt": "2024-09-09T14:08:2626+01:00",
        "id": "66deb0c395f3cd56ddfe6a17"
    },
    "links": []
}
{
  "success": false,
  "statusCode": 404,
  "message": "You have attempted to get a resource that does not exist.",
  "name": "ResourceNotFoundError",
  "data": {}
}

Last updated

Was this helpful?