Package version:

interface CreateLivenessSession {
    get(options?): StreamableMethod<GetLivenessSessions200Response | GetLivenessSessionsDefaultResponse>;
    post(options?): StreamableMethod<CreateLivenessSession200Response | CreateLivenessSessionDefaultResponse>;
}

Methods

Methods

  • 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...

      • Ability to call /detectLiveness/singleModal for up to 3 retries.
      • A token lifetime of 10 minutes.

    [!NOTE] Client access can be revoked by deleting the session using the Delete Liveness Session operation. To retrieve a result, use the Get Liveness Session. To audit the individual requests that a client has made to your resource, use the List Liveness Session Audit Entries.

    Parameters

    • Optional options: any

    Returns StreamableMethod<CreateLivenessSession200Response | CreateLivenessSessionDefaultResponse>