Skip to main content
cURL

Autorizaciones

x-api-key
string
header
requerido

Cuerpo

application/json
selfie
string
requerido

Selfie image of the subject in Base64 (PNG/JPG).

allowMultipleFaces
boolean
predeterminado:false

Optional. When false (default), a selfie with another person in frame returns MULTIPLE_FACES_DETECTED. When true, the largest face in the image is evaluated and the others are ignored.

Respuesta

Liveness analysis result (Strict Envelope Pattern).

status
enum<string>
requerido

High-level outcome. OK means the request was successfully processed (regardless of business result). ERROR means the request was rejected or could not be processed.

Opciones disponibles:
OK,
ERROR
type
string
requerido

Stable result type code. Includes generic codes (SUCCESS, INVALID_REQUEST, UNAUTHORIZED, SERVICE_UNAVAILABLE, INTERNAL_ERROR, RATE_LIMIT_EXCEEDED) plus endpoint-specific result codes — see this endpoint's response examples.

message
string
requerido

Human-readable summary of the result. Always in English (per Language Conventions in the API overview).

transactionId
string<uuid>
requerido

Unique identifier of this request, generated by the API Gateway. Propagated end-to-end for traceability.

processedAt
string<date-time>
requerido

ISO 8601 datetime with Mexico City offset (-06:00). Always set by the API Gateway when the response leaves the system.

billable
boolean
requerido

Whether this request will be charged against the client's plan. Typically true for successful business results and false for validation errors or system errors that prevented processing.

data
object | null

Liveness result. Null for INVALID_REQUEST, INTERNAL_ERROR and SERVICE_UNAVAILABLE. On every OK outcome the object is present: when nothing could be evaluated (NO_FACE_DETECTED, MULTIPLE_FACES_DETECTED, IMAGE_UNREADABLE) isLive is false and the remaining fields are null.

errors
object[]

Per-field error details. Present only on INVALID_REQUEST responses.