Generate SDK Liveness Token

This endpoint allows the user to generate a liveness token

SDK Liveness Token

POST {{baseurl}}/v2/api/identity/sdk/liveness/token

Headers

Name
Type
Description

token*

String

API secret token

Field
Type
Description

publicMerchantID*

String

Public merchant ID

action

String

Action to perform

Allowed values: "detectLiveness", "detectLivenessWithVerify"

livenessOperationMode

String

Liveness mode

Default value: Passive

Allowed values: "Passive", "PassiveActive"

sendResultsToClient

Boolean

Whether to send results to client

Default value: true

deviceCorrelationId

String

Device correlation ID

deviceId

String

deviceId to derive deviceCorrelationId

VerifyImage

File

Image file for verify variant

{
 "publicMerchantID":"92hfbw9ub299929b"
}
{
  "success": true,
  "statusCode": 200,
  "message": "Liveness token fetched successfully!",
  "data": {
    "authToken": "eyJhbGciOi...",
    "sessionId": "b15a8d20-c602-..."
  },
  "links": []
}

Last updated

Was this helpful?