Skip to main content
POST
/
identity
/
liveness
Check liveness
curl --request POST \
  --url https://api.txcloud.io/v1/identity/liveness \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "image": "aSDinaTvuI8gbWludGxpZnk=",
  "mode": "passive",
  "frames": [
    "aSDinaTvuI8gbWludGxpZnk="
  ]
}
'
{
  "id": "<string>",
  "object": "identity.liveness",
  "is_live": true,
  "confidence": 123,
  "spoof_probability": 123,
  "spoof_type": "none",
  "signals": [
    "<string>"
  ]
}

Authorizations

Authorization
string
header
required

API key as Bearer token

Body

application/json
image
string<byte>
required
mode
enum<string>
default:passive
Available options:
passive,
active
frames
string<byte>[]

Additional frames for active mode

Response

200 - application/json

Liveness check result

id
string
object
enum<string>
Available options:
identity.liveness
is_live
boolean
confidence
number
spoof_probability
number
spoof_type
enum<string>
Available options:
none,
photo,
screen,
mask,
deepfake
signals
string[]