Package version:

Interface CreateLivenessSessionContent

Request for creating liveness session.

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

Properties

authTokenTimeToLiveInSeconds? deviceCorrelationId? deviceCorrelationIdSetInClient? livenessOperationMode sendResultsToClient?

Properties

Optional authTokenTimeToLiveInSeconds

authTokenTimeToLiveInSeconds?: number

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

Optional deviceCorrelationId

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.

Optional deviceCorrelationIdSetInClient

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.

livenessOperationMode

livenessOperationMode: string

Type of liveness mode the client should follow.

Optional sendResultsToClient

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

Theme