Retrieve a Liveness Check Result
/api/v2/liveness_check
operationId: liveness_check_result
Live: https://gdapi.globaldata.net.au/api/v2/liveness_check · Sandbox: https://sandbox-gdapi.globaldata.net.au/api/v2/liveness_check
Retrieves the current status or final result of a previously created liveness check using the token
returned by the create (POST) endpoint. This endpoint is idempotent and can be safely polled until a
terminal state is reached.
Status lifecycle
A liveness check progresses through these internal states:
pending- Created but not yet claimed by the client (no session started).in_progress- Claimed and session active / capturing.complete- Result available (successful or failed evaluation) and this endpoint returns HTTP 200.expired- Link validity period elapsed without completion; no result available.
While the check is pending or in_progress, this endpoint returns HTTP 202 with a descriptive message
(Liveness check is pending or Liveness check is in progress). Once processing is finished it returns HTTP 200.
If a check has expired without completion, it will return HTTP 410 with the message Liveness check has expired.
Polling guidance
Recommended polling interval: 2-3 seconds. Exponential backoff is encouraged to reduce load. Stop polling once HTTP 200 is received or if you determine from your own business logic the check should be abandoned.
Result object
On success (HTTP 200) the response includes a result object mirroring what was stored for the check:
passed(boolean) - Indicates whether the captured face passed the liveness evaluation.confidence(number) - Confidence score returned by the liveness provider.threshold(integer 0-99) - Either the custom value provided at creation or the system default.checked_at(datetime) - Time the result was finalized.error(string, only when failed/expired) - Terminal error code (failedorexpired).
Optional fields when available:
image- Base64 data URI (JPEG) of the probe frame (only if retained and not yet expired from short-term cache).audit_images- Array of objects each containing:image- Base64 data URI (JPEG) of an intermediate frame.bounding_box- Optional bounding box metadata (structure may evolve, treat as informational).
Images are ephemeral (cached ~30 minutes). After expiry the same result will be returned without images.
Security considerations
Always perform this query from a trusted backend using your API key. Do not trust the client-provided
lc_token query parameter from the redirect alone; validate it by fetching the result here (403/400 will
protect you if the token does not belong to your account).
Error / edge cases
- Missing or unknown
token=> HTTP 400Invalid check token. - Access without product entitlement => HTTP 403.
- Rate limiting => HTTP 429 (standard throttling rules apply).
Query parameters
| Field | Description |
|---|---|
tokenrequired |
string The token identifying the liveness check (returned from the create endpoint) |
Responses
Liveness check completed - final result returned
application/json
| Field | Description |
|---|---|
message |
string Always |
api_reference |
string (uuid) Unique identifier for this request (audit reference). |
result |
object Liveness evaluation result |
result. |
boolean Indicates whether the subject was deemed live (true) or not (false). |
result. |
number (float) Confidence score produced by the liveness provider. |
result. |
integer Threshold applied when interpreting the score. |
result. |
string (date-time) Timestamp when the liveness result was finalized. |
result. |
string Terminal error code for failed / expired checks. |
result. |
object Optional bounding box metadata for the detected face. |
result. |
string Probe image (data URI) if still available. |
result. |
array of objects Array of intermediate audit frame images if requested and available. |
result. |
string Audit frame image (data URI) |
result. |
object Optional bounding box metadata for the detected face. |
Liveness check not yet complete (pending or in progress)
application/json
| Field | Description |
|---|---|
message |
string Status message - either |
Liveness check has expired
application/json
| Field | Description |
|---|---|
message |
string Expiry message |