Check liveness
POST /v2/liveness
Check face liveness, active speaker detection, and visual speech recognition anti-spoofing on the submitted video.
Authorizations
Request Body required
object
object
Optional human-readable label for the user (e.g. an email), recorded on the transaction for display. Never used as an identity; user_id remains the biometric key.
Optional session identifier for combined scoring.
Optional contextual trigger event name.
object
Services to skip from the verification pipeline.
The phrase the user speaks. Always required on /v2/voice-verify (voice recognition). On /v2/liveness it is required when visual speech recognition runs (the default) and unused when that service is excluded or not enabled. A missing required phrase is a 400 invalid_request.
Vocabulary hint for speech recognition (e.g. en_digits).
Captured video recording (with speech if checking active speaker / visual speech).
Responses
200
Liveness analysis complete.
object
Endpoint-specific payload; omitted when the operation returns no data.
Scoring decision computed for the request when a scoring system applies.
object
Decision status from the scoring engine (e.g. pass, fail, refer).
object
Non-fatal caveats about a successful result — for example an enrollment that succeeded but produced a weaker biometric template.
Raw per-service results; only services enabled for the API key appear.
object
object
object
object
400
Bad Request / Parameter Validation Failed.
object
object
invalid_requestHuman-readable message; a string, or a field-error array for validation failures.
object
Non-fatal caveats about a successful result — for example an enrollment that succeeded but produced a weaker biometric template.
401
Unauthorized / Missing or Invalid Authentication Credentials.
object
object
invalid_requestHuman-readable message; a string, or a field-error array for validation failures.
object
Non-fatal caveats about a successful result — for example an enrollment that succeeded but produced a weaker biometric template.
422
Unprocessable Entity / Face not detected, audio unreadable, or file payload syntax error.
object
object
invalid_requestHuman-readable message; a string, or a field-error array for validation failures.
object
Non-fatal caveats about a successful result — for example an enrollment that succeeded but produced a weaker biometric template.
500
Internal Server Error.
object
object
invalid_requestHuman-readable message; a string, or a field-error array for validation failures.
object
Non-fatal caveats about a successful result — for example an enrollment that succeeded but produced a weaker biometric template.