Package version:

Interface LivenessSessionOutput

Session result of detect liveness.

interface LivenessSessionOutput {
    authTokenTimeToLiveInSeconds?: number;
    createdDateTime: string;
    deviceCorrelationId?: string;
    id: string;
    result?: LivenessSessionAuditEntryOutput;
    sessionExpired: boolean;
    sessionStartDateTime?: string;
    status: string;
}

Properties

authTokenTimeToLiveInSeconds? createdDateTime deviceCorrelationId? id result? sessionExpired sessionStartDateTime? status

Properties

Optional authTokenTimeToLiveInSeconds

authTokenTimeToLiveInSeconds?: number

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

createdDateTime

createdDateTime: string

DateTime when this session was created.

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.

Readonly id

id: string

The unique ID to reference this session.

Optional result

result?: LivenessSessionAuditEntryOutput

The latest session audit result only populated if status == 'ResultAvailable'.

sessionExpired

sessionExpired: boolean

Whether or not the session is expired.

Optional sessionStartDateTime

sessionStartDateTime?: string

DateTime when this session was started by the client.

status

status: string

The current status of the session.

Settings

Member Visibility

Theme