Package version:

Interface CreateLivenessSessionContent

Request model for creating liveness session.

interface CreateLivenessSessionContent {
    authTokenTimeToLiveInSeconds?: number;
    deviceCorrelationId?: string;
    deviceCorrelationIdSetInClient?: boolean;
    enableSessionImage?: boolean;
    livenessOperationMode: string;
    livenessSingleModalModel?: string;
    sendResultsToClient?: boolean;
}

Properties

authTokenTimeToLiveInSeconds? deviceCorrelationId? deviceCorrelationIdSetInClient? enableSessionImage? livenessOperationMode livenessSingleModalModel? sendResultsToClient?

Properties

OptionalauthTokenTimeToLiveInSeconds

authTokenTimeToLiveInSeconds?: number

Seconds the session should last for. Range is 60 to 86400 seconds. Default value is 600.

OptionaldeviceCorrelationId

deviceCorrelationId?: string

Unique Guid per each end-user device. This is to provide rate limiting and anti-hammering. If 'deviceCorrelationIdSetInClient' is true in this request, this 'deviceCorrelationId' must be null.

OptionaldeviceCorrelationIdSetInClient

deviceCorrelationIdSetInClient?: boolean

Whether or not to allow client to set their own 'deviceCorrelationId' via the Vision SDK. Default is false, and 'deviceCorrelationId' must be set in this request body.

OptionalenableSessionImage

enableSessionImage?: boolean

Whether or not store the session image.

livenessOperationMode

livenessOperationMode: string

Type of liveness mode the client should follow.

Possible values: "Passive", "PassiveActive"

OptionallivenessSingleModalModel

livenessSingleModalModel?: string

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: "2022-10-15-preview.04", "2023-12-20-preview.06"

OptionalsendResultsToClient

sendResultsToClient?: boolean

Whether or not to allow a '200 - Success' response body to be sent to the client, which may be undesirable for security reasons. Default is false, clients will receive a '204 - NoContent' empty body response. Regardless of selection, calling Session GetResult will always contain a response body enabling business logic to be implemented.

Settings

Member Visibility