FaceSessionClient.CreateLivenessWithVerifySession Method

  • Reference

Definition

Namespace:
Azure.AI.Vision.Face
Assembly:
Azure.AI.Vision.Face.dll
Package:
Azure.AI.Vision.Face v1.0.0-beta.1
Source:
FaceSessionClient.cs

Create a new liveness session with verify. Provide the verify image during session creation.

public virtual Azure.Response<Azure.AI.Vision.Face.CreateLivenessWithVerifySessionResult> CreateLivenessWithVerifySession (Azure.AI.Vision.Face.CreateLivenessSessionContent createLivenessSessionContent, System.IO.Stream verifyImage, System.Threading.CancellationToken cancellationToken = default);
abstract member CreateLivenessWithVerifySession : Azure.AI.Vision.Face.CreateLivenessSessionContent * System.IO.Stream * System.Threading.CancellationToken -> Azure.Response<Azure.AI.Vision.Face.CreateLivenessWithVerifySessionResult>
override this.CreateLivenessWithVerifySession : Azure.AI.Vision.Face.CreateLivenessSessionContent * System.IO.Stream * System.Threading.CancellationToken -> Azure.Response<Azure.AI.Vision.Face.CreateLivenessWithVerifySessionResult>
Public Overridable Function CreateLivenessWithVerifySession (createLivenessSessionContent As CreateLivenessSessionContent, verifyImage As Stream, Optional cancellationToken As CancellationToken = Nothing) As Response(Of CreateLivenessWithVerifySessionResult)

Parameters

createLivenessSessionContent
CreateLivenessSessionContent

Parameters for liveness with verify session creation.

verifyImage
Stream

Image binary data for verify image, can be provided as session creation time or during the /detectLivenessWithVerify/singleModal

cancellationToken
CancellationToken

The cancellation token to use.

Returns

Response<CreateLivenessWithVerifySessionResult>

Exceptions

ArgumentNullException

createLivenessSessionContent is null.

Remarks

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 /detectLivenessWithVerify/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 With Verify Session operation. > * To retrieve a result, use the Get Liveness With Verify Session. > * To audit the individual requests that a client has made to your resource, use the List Liveness With Verify Session Audit Entries.

Recommended Option: VerifyImage is provided during session creation. Alternative Option: Client device submits VerifyImage during the /detectLivenessWithVerify/singleModal call. > [!NOTE] > Extra measures should be taken to validate that the client is sending the expected VerifyImage.

Applies to