v5

latestSwagger 2.02026-07-136680294.1 KB

Create a new liveness session with verify. Provide the verify image during session creation.

A session is best for client device scenarios where developers want to authorize a client device to perform only a liveness detection without granting full access to their resource. Created sessions have a limited life span and only authorize clients to perform the desired action before access is expired.

Permissions includes...

- A token lifetime of 10 minutes.

[!NOTE]

Client access can be revoked by deleting the session using the Delete Liveness With Verify Session operation.

To retrieve a result, use the Get Liveness With Verify Session.

To audit the individual requests that a client has made to your resource, use the List Liveness With Verify Session Audit Entries.

post/detectLivenessWithVerify-sessions

Response

A successful call create a session for a client device and provide an authorization token for use by the client application for a limited purpose and time.

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.