v1

latestOpenAPI 3.0.32026-07-14108241269.2 KB
Liveness v2

Liveness Detection v2

Runs a passive liveness check on a supplied face image to determine whether it represents a live person rather than a spoof (printed photo, screen replay, or mask). Returns a boolean is_live verdict together with a normalized liveness score. A low-confidence or spoofed image still completes successfully (status: "success") with is_live: false.

Response contract: Every completed verification returns HTTP 200. A successful result returns status: "success" with error_code: null and a populated data object. A valid request with no matching record (or a business rejection) also returns HTTP 200 with status: "failed", a non-null error_code, and data: null. Do not treat HTTP 200 alone as success — always branch on status and inspect error_code. Authenticate with your X-Client-ID and X-API-KEY headers. Transport, auth, and validation problems use standard 4xx/5xx status codes.

post/v2/verify/liveness

Request body

personstring required

Face image to evaluate, as a base64-encoded string (raw base64 or a data URI).

Example request

{
  "person": "data:image/jpeg;base64,/9j/4AAQSkZJRgABAQAAAQ..."
}

Response

Liveness check completed. data.is_live carries the verdict.

statusstring required
messagestring nullable
error_codestring nullable
tranx_idstring nullable
timestampstring nullable