v5

latestSwagger 2.02026-07-136680294.1 KB

Get session result of detectLiveness/singleModal call.

get/detectLiveness-sessions/{sessionId}

Path parameters

sessionIdstring required

The unique ID to reference this session.

Response

The request has succeeded.

sessionIdstring required

The unique ID to reference this session.

authTokenstring required

Bearer token to provide authentication for the Vision SDK running on a client application. This Bearer token has limited permissions to perform only the required action and expires after the TTL time. It is also auditable.

status'NotStarted' | 'Running' | 'Succeeded' | 'Failed' | 'Canceled' required

Enum describing allowed operation states.

modelVersion'2024-11-15'

The model version used for liveness classification.

isAbuseMonitoringEnabledobject

Denotes if the abuse monitoring feature was enabled during this session.

expectedClientIpAddressstring

The expected IP address or CIDR block of the client that runs the liveness check.