Share via


LivenessSessionOutput interface

Session result of detect liveness.

Properties

authToken

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.

modelVersion

The model version used for liveness classification. This is an optional parameter, and if this is not specified, then the latest supported model version will be chosen

Possible values: "2024-11-15"

results

The results of the liveness session.

sessionId

The unique ID to reference this session.

status

The current status of the session.

Possible values: "NotStarted", "Running", "Succeeded", "Failed", "Canceled"

Property Details

authToken

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.

authToken: string

Property Value

string

modelVersion

The model version used for liveness classification. This is an optional parameter, and if this is not specified, then the latest supported model version will be chosen

Possible values: "2024-11-15"

modelVersion?: string

Property Value

string

results

The results of the liveness session.

results: LivenessSessionResultsOutput

Property Value

sessionId

The unique ID to reference this session.

sessionId: string

Property Value

string

status

The current status of the session.

Possible values: "NotStarted", "Running", "Succeeded", "Failed", "Canceled"

status: string

Property Value

string