Liveness Session Operations - Get Session Image

Service:

Azure AI Services

API Version:

v1.2

Get session image stored during the liveness session.

GET {endpoint}/face/{apiVersion}/sessionImages/{sessionImageId}

URI Parameters

Name	In	Required	Type	Description
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).
sessionImageId	path	True	string	The request ID of the image to be retrieved

Responses

Name	Type	Description
200 OK	file	The request has succeeded. Media Types: "application/octet-stream", "application/json"
Other Status Codes	FaceErrorResponse	An unexpected error response. Media Types: "application/octet-stream", "application/json" 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

Get Session Image

Sample request

HTTP

GET {endpoint}/face/v1.2/sessionImages/3d035d35-2e01-4ed4-8935-577afde9caaa

Sample response

Status code:

200

"<session-image-bytes>"

Definitions

Name	Description
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.

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.