Liveness Session Operations - Create Liveness With Verify Session With Verify Image

  • Reference
Service:
Azure AI Services
API Version:
v1.1-preview.1

Create a new liveness session with verify. Provide the verify image during session creation.
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.

POST {endpoint}/face/{apiVersion}/detectLivenessWithVerify/singleModal/sessions

URI Parameters

Name In Required Type Description
Parameters
 formData True

string

The parameters for creating session.
VerifyImage
 formData True

file

The image stream for verify. Content-Disposition header field for this part must have filename.
apiVersion
 path True

string

API Version
endpoint
 path True

string

uri

Supported Cognitive Services endpoints (protocol and hostname, for example: https://{resource-name}.cognitiveservices.azure.com).

Responses

Name Type Description
200 OK

CreateLivenessWithVerifySessionResult

A successful call create a session for a client device and provide an authorization token for use by the client application for a limited purpose and time.
Other Status Codes

FaceErrorResponse

An unexpected error response.

Headers

x-ms-error-code: string

Security

Ocp-Apim-Subscription-Key

The secret key for your Azure AI Face subscription.

Type: apiKey
In: header

AADToken

The Azure Active Directory OAuth2 Flow

Type: oauth2
Flow: accessCode
Authorization URL: https://api.example.com/oauth2/authorize
Token URL: https://api.example.com/oauth2/token

Scopes

Name Description
https://cognitiveservices.azure.com/.default

Examples

Create LivenessWithVerify Session with VerifyImage

Sample request

POST {endpoint}/face/v1.1-preview.1/detectLivenessWithVerify/singleModal/sessions

Sample response

Status code:
200 
{
  "sessionId": "b12e033e-bda7-4b83-a211-e721c661f30e",
  "authToken": "eyJhbGciOiJFUzI1NiIsIm",
  "verifyImage": {
    "faceRectangle": {
      "width": 78,
      "height": 78,
      "left": 394,
      "top": 54
    },
    "qualityForRecognition": "high"
  }
}

Definitions

Name Description
CreateLivenessWithVerifySessionResult

Response of liveness session with verify creation with verify image provided.
FaceError

The error object. For comprehensive details on error codes and messages returned by the Face Service, please refer to the following link: https://aka.ms/face-error-codes-and-messages.
FaceErrorResponse

A response containing error details.
FaceRectangle

A rectangle within which a face can be found.
LivenessWithVerifyImage

The detail of face for verification.
QualityForRecognition

Indicates quality of image for recognition.

CreateLivenessWithVerifySessionResult

Response of liveness session with verify creation with verify image provided.

Name Type Description
authToken

string

Bearer token to provide authentication for the Vision SDK running on a client application. This Bearer token has limited permissions to perform only the required action and expires after the TTL time. It is also auditable.
sessionId

string

The unique session ID of the created session. It will expire 48 hours after it was created or may be deleted sooner using the corresponding Session DELETE operation.
verifyImage

LivenessWithVerifyImage

The detail of face for verification.

FaceError

The error object. For comprehensive details on error codes and messages returned by the Face Service, please refer to the following link: https://aka.ms/face-error-codes-and-messages.

Name Type Description
code

string

One of a server-defined set of error codes.
message

string

A human-readable representation of the error.

FaceErrorResponse

A response containing error details.

Name Type Description
error

FaceError

The error object.

FaceRectangle

A rectangle within which a face can be found.

Name Type Description
height

integer

The height of the rectangle, in pixels.
left

integer

The distance from the left edge if the image to the left edge of the rectangle, in pixels.
top

integer

The distance from the top edge if the image to the top edge of the rectangle, in pixels.
width

integer

The width of the rectangle, in pixels.

LivenessWithVerifyImage

The detail of face for verification.

Name Type Description
faceRectangle

FaceRectangle

The face region where the comparison image's classification was made.
qualityForRecognition

QualityForRecognition

Quality of face image for recognition.

QualityForRecognition

Indicates quality of image for recognition.

Name Type Description
high

string

High quality.
low

string

Low quality.
medium

string

Medium quality.