Face API - v1.1-preview.1

This API is currently available in:

  • Australia East - australiaeast.api.cognitive.microsoft.com
  • Brazil South - brazilsouth.api.cognitive.microsoft.com
  • Canada Central - canadacentral.api.cognitive.microsoft.com
  • Central India - centralindia.api.cognitive.microsoft.com
  • Central US - centralus.api.cognitive.microsoft.com
  • East Asia - eastasia.api.cognitive.microsoft.com
  • East US - eastus.api.cognitive.microsoft.com
  • East US 2 - eastus2.api.cognitive.microsoft.com
  • France Central - francecentral.api.cognitive.microsoft.com
  • Germany West Central - germanywestcentral.api.cognitive.microsoft.com
  • Italy North - italynorth.api.cognitive.microsoft.com
  • Japan East - japaneast.api.cognitive.microsoft.com
  • Japan West - japanwest.api.cognitive.microsoft.com
  • Jio India West - jioindiawest.api.cognitive.microsoft.com
  • Korea Central - koreacentral.api.cognitive.microsoft.com
  • North Central US - northcentralus.api.cognitive.microsoft.com
  • North Europe - northeurope.api.cognitive.microsoft.com
  • Norway East - norwayeast.api.cognitive.microsoft.com
  • Qatar Central - qatarcentral.api.cognitive.microsoft.com
  • South Africa North - southafricanorth.api.cognitive.microsoft.com
  • South Central US - southcentralus.api.cognitive.microsoft.com
  • Southeast Asia - southeastasia.api.cognitive.microsoft.com
  • Sweden Central - swedencentral.api.cognitive.microsoft.com
  • Switzerland North - switzerlandnorth.api.cognitive.microsoft.com
  • Switzerland West - switzerlandwest.api.cognitive.microsoft.com
  • UAE North - uaenorth.api.cognitive.microsoft.com
  • UK South - uksouth.api.cognitive.microsoft.com
  • West Central US - westcentralus.api.cognitive.microsoft.com
  • West Europe - westeurope.api.cognitive.microsoft.com
  • West US - westus.api.cognitive.microsoft.com
  • West US 2 - westus2.api.cognitive.microsoft.com
  • West US 3 - westus3.api.cognitive.microsoft.com

Session DetectLiveness SingleModal - Audit Requests

Gets session requests and response body for the session.

Select the testing console in the region where you created your resource:

Australia East Brazil South Canada Central Central India Central US East Asia East US East US 2 France Central Germany West Central Japan East Japan West Jio India West Korea Central North Central US North Europe Norway East Qatar Central South Africa North South Central US Southeast Asia Sweden Central Switzerland North Switzerland West UAE North UK South West Central US West Europe West US West US 2 West US 3

Request URL

Request parameters

(optional)
string

List audit entries for detectLiveness/singleModal from the last id less than the "start". It contains no more than 64 characters. Default is empty.

(optional)
string

The number of audit entries to list, ranging in [1, 1000]. Default is 1000.

Request headers

string
Subscription key which provides access to this API. Found in your Cognitive Services accounts.

Request body

Response 200

A successful call returns the audit results call.

Fields Type Description
id String Unique id to refer to this audit request. Use this id with the 'start' query parameter to continue on to the next page of audit results.
sessionId String Unique sessionId of the created session. It will expire after expire 48 hours after it was created or may be deleted sooner using the corresponding session DELETE operation.
requestId String Unique request-id that is returned by the service to the client in the 'apim-request-id' header.
clientRequestId String Unique client-request-id that is sent by the client in the 'client-request-id' header.
receivedDateTime DateTime UTC DateTime that the request was received.
digest string The server calculated digest for this request. If the client reported digest differs from the server calculated digest then the message integrity between the client and service has been compromised and the result should not be trusted. For more information see how to guides on how to leverage this value to secure your end-to-end solution.
request.url string Relative path + query of this request.
request.method string Http Method. ie. GET, POST, DELETE
request.contentLength (optional) long Length of the request content.
result.contentType string The Content-Type of the request received.
result.userAgent string The user agent used to submit the request.
response.statusCode string The status code returned to the client.
response.latencyInMilliseconds string The server measured latency for this request in milliseconds.
response.body Object The schema of this field will depend on the request.url and request.method used by the client. 

[{
    "id": "1",
    "sessionId": "ebfc2ee4-197c-45ee-8c49-2eb08da57fc3",
    "requestId": "3f08db40-687e-414b-8931-0c0eb509a763",
    "dateReceived": "2023-10-20T23:09:59.4533078+00:00",
    "request": {
        "url": "/face/v1.1-preview.1/detectLiveness/singleModal",
        "method": "POST",
        "contentLength": 360030,
        "contentType": "multipart/form-data; boundary=--------------------------087499987152446464473896",
        "userAgent": "VisionSDK-objective-c/0.15.1-alpha.0.1 (Darwin Darwin 22.6.0)"
    },
    "response": {
        "body": {
            "livenessDecision": "spoofface",
            "target": {
                "faceRectangle": {
                    "top": 782,
                    "left": 260,
                    "width": 858,
                    "height": 984
                },
                "fileName": "video.webp",
                "timeOffsetWithinFile": 0,
                "imageType": "Color"
            },
            "modelVersionUsed": "2022-10-15-preview.04"
        },
        "statusCode": 200,
        "latencyInMS": 2037
    },
    "digest": "1CC98BA83EAF1D0FF7F566FAEFCCCC787819FFA01251E2D9299143F7AD6651DB"
}]

Response 400

Error code and message returned in JSON:

Error CodeError Message Description
BadArgumentStart parameter is invalid. Please specify the 'Id' field of the last entry to continue the listing process.
BadArgumentTop parameter is invalid. Valid range is between 1 and 1000 inclusive.
 

{
    "error": {
        "code": "BadArgument",
        "message": "Start parameter is invalid. Please specify the 'Id' field of the last entry to continue the listing process."
    }
}

Response 401

Error code and message returned in JSON:

Error CodeError Message Description
UnspecifiedInvalid subscription Key or user/plan is blocked.
 

{
    "error": {
        "code": "Unspecified",
        "message": "Access denied due to invalid subscription key. Make sure you are subscribed to an API you are trying to call and provide the right key."
    }
}

Response 403

{
    "error": {
        "statusCode": 403,
        "message": "Out of call volume quota. Quota will be replenished in 2 days."
    }
}

Response 404

Error code and message returned in JSON:

Error Code Error Message Description
SessionNotFound Session Id is not found. The session id is expired or does not exist. 

{
    "error": {
        "code": "SessionNotFound",
        "message": "Session Id is not found. The session id is expired or does not exist."
    }
}

Response 415

Unsupported media type error. Only "application/json" is valid for this API.

{
    "error": {
        "code": "BadArgument",
        "message": "Invalid Media Type."
    }
}

Response 429

{
    "error": {
        "statusCode": 429,
        "message": "Rate limit is exceeded. Try again in 26 seconds."
    }
}

Code samples

@ECHO OFF

curl -v -X GET "https://norwayeast.api.cognitive.microsoft.com/face/v1.1-preview.1/detectLiveness/singleModal/sessions/{sessionId}/audit?start={string}&top={string}"
-H "Ocp-Apim-Subscription-Key: {subscription key}"

--data-ascii "{body}" 

using System;
using System.Net.Http.Headers;
using System.Text;
using System.Net.Http;
using System.Web;

namespace CSHttpClientSample
{
    static class Program
    {
        static void Main()
        {
            MakeRequest();
            Console.WriteLine("Hit ENTER to exit...");
            Console.ReadLine();
        }
        
        static async void MakeRequest()
        {
            var client = new HttpClient();
            var queryString = HttpUtility.ParseQueryString(string.Empty);

            // Request headers
            client.DefaultRequestHeaders.Add("Ocp-Apim-Subscription-Key", "{subscription key}");

            // Request parameters
            queryString["start"] = "{string}";
            queryString["top"] = "{string}";
            var uri = "https://norwayeast.api.cognitive.microsoft.com/face/v1.1-preview.1/detectLiveness/singleModal/sessions/{sessionId}/audit?" + queryString;

            var response = await client.GetAsync(uri);
        }
    }
}	
// // This sample uses the Apache HTTP client from HTTP Components (http://hc.apache.org/httpcomponents-client-ga/)
import java.net.URI;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpGet;
import org.apache.http.client.utils.URIBuilder;
import org.apache.http.impl.client.HttpClients;
import org.apache.http.util.EntityUtils;

public class JavaSample 
{
    public static void main(String[] args) 
    {
        HttpClient httpclient = HttpClients.createDefault();

        try
        {
            URIBuilder builder = new URIBuilder("https://norwayeast.api.cognitive.microsoft.com/face/v1.1-preview.1/detectLiveness/singleModal/sessions/{sessionId}/audit");

            builder.setParameter("start", "{string}");
            builder.setParameter("top", "{string}");

            URI uri = builder.build();
            HttpGet request = new HttpGet(uri);
            request.setHeader("Ocp-Apim-Subscription-Key", "{subscription key}");


            // Request body
            StringEntity reqEntity = new StringEntity("{body}");
            request.setEntity(reqEntity);

            HttpResponse response = httpclient.execute(request);
            HttpEntity entity = response.getEntity();

            if (entity != null) 
            {
                System.out.println(EntityUtils.toString(entity));
            }
        }
        catch (Exception e)
        {
            System.out.println(e.getMessage());
        }
    }
}


<!DOCTYPE html>
<html>
<head>
    <title>JSSample</title>
    <script src="http://ajax.googleapis.com/ajax/libs/jquery/1.9.0/jquery.min.js"></script>
</head>
<body>

<script type="text/javascript">
    $(function() {
        var params = {
            // Request parameters
            "start": "{string}",
            "top": "{string}",
        };
      
        $.ajax({
            url: "https://norwayeast.api.cognitive.microsoft.com/face/v1.1-preview.1/detectLiveness/singleModal/sessions/{sessionId}/audit?" + $.param(params),
            beforeSend: function(xhrObj){
                // Request headers
                xhrObj.setRequestHeader("Ocp-Apim-Subscription-Key","{subscription key}");
            },
            type: "GET",
            // Request body
            data: "{body}",
        })
        .done(function(data) {
            alert("success");
        })
        .fail(function() {
            alert("error");
        });
    });
</script>
</body>
</html>

#import <Foundation/Foundation.h>

int main(int argc, const char * argv[])
{
    NSAutoreleasePool * pool = [[NSAutoreleasePool alloc] init];
    
    NSString* path = @"https://norwayeast.api.cognitive.microsoft.com/face/v1.1-preview.1/detectLiveness/singleModal/sessions/{sessionId}/audit";
    NSArray* array = @[
                         // Request parameters
                         @"entities=true",
                         @"start={string}",
                         @"top={string}",
                      ];
    
    NSString* string = [array componentsJoinedByString:@"&"];
    path = [path stringByAppendingFormat:@"?%@", string];

    NSLog(@"%@", path);

    NSMutableURLRequest* _request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:path]];
    [_request setHTTPMethod:@"GET"];
    // Request headers
    [_request setValue:@"{subscription key}" forHTTPHeaderField:@"Ocp-Apim-Subscription-Key"];
    // Request body
    [_request setHTTPBody:[@"{body}" dataUsingEncoding:NSUTF8StringEncoding]];
    
    NSURLResponse *response = nil;
    NSError *error = nil;
    NSData* _connectionData = [NSURLConnection sendSynchronousRequest:_request returningResponse:&response error:&error];

    if (nil != error)
    {
        NSLog(@"Error: %@", error);
    }
    else
    {
        NSError* error = nil;
        NSMutableDictionary* json = nil;
        NSString* dataString = [[NSString alloc] initWithData:_connectionData encoding:NSUTF8StringEncoding];
        NSLog(@"%@", dataString);
        
        if (nil != _connectionData)
        {
            json = [NSJSONSerialization JSONObjectWithData:_connectionData options:NSJSONReadingMutableContainers error:&error];
        }
        
        if (error || !json)
        {
            NSLog(@"Could not parse loaded json with error:%@", error);
        }
        
        NSLog(@"%@", json);
        _connectionData = nil;
    }
    
    [pool drain];

    return 0;
}

<?php
// This sample uses the Apache HTTP client from HTTP Components (http://hc.apache.org/httpcomponents-client-ga/)
require_once 'HTTP/Request2.php';

$request = new Http_Request2('https://norwayeast.api.cognitive.microsoft.com/face/v1.1-preview.1/detectLiveness/singleModal/sessions/{sessionId}/audit');
$url = $request->getUrl();

$headers = array(
    // Request headers
    'Ocp-Apim-Subscription-Key' => '{subscription key}',
);

$request->setHeader($headers);

$parameters = array(
    // Request parameters
    'start' => '{string}',
    'top' => '{string}',
);

$url->setQueryVariables($parameters);

$request->setMethod(HTTP_Request2::METHOD_GET);

// Request body
$request->setBody("{body}");

try
{
    $response = $request->send();
    echo $response->getBody();
}
catch (HttpException $ex)
{
    echo $ex;
}

?>
########### Python 2.7 #############
import httplib, urllib, base64

headers = {
    # Request headers
    'Ocp-Apim-Subscription-Key': '{subscription key}',
}

params = urllib.urlencode({
    # Request parameters
    'start': '{string}',
    'top': '{string}',
})

try:
    conn = httplib.HTTPSConnection('norwayeast.api.cognitive.microsoft.com')
    conn.request("GET", "/face/v1.1-preview.1/detectLiveness/singleModal/sessions/{sessionId}/audit?%s" % params, "{body}", headers)
    response = conn.getresponse()
    data = response.read()
    print(data)
    conn.close()
except Exception as e:
    print("[Errno {0}] {1}".format(e.errno, e.strerror))

####################################

########### Python 3.2 #############
import http.client, urllib.request, urllib.parse, urllib.error, base64

headers = {
    # Request headers
    'Ocp-Apim-Subscription-Key': '{subscription key}',
}

params = urllib.parse.urlencode({
    # Request parameters
    'start': '{string}',
    'top': '{string}',
})

try:
    conn = http.client.HTTPSConnection('norwayeast.api.cognitive.microsoft.com')
    conn.request("GET", "/face/v1.1-preview.1/detectLiveness/singleModal/sessions/{sessionId}/audit?%s" % params, "{body}", headers)
    response = conn.getresponse()
    data = response.read()
    print(data)
    conn.close()
except Exception as e:
    print("[Errno {0}] {1}".format(e.errno, e.strerror))

####################################
require 'net/http'

uri = URI('https://norwayeast.api.cognitive.microsoft.com/face/v1.1-preview.1/detectLiveness/singleModal/sessions/{sessionId}/audit')

query = URI.encode_www_form({
    # Request parameters
    'start' => '{string}',
    'top' => '{string}'
})
if query.length > 0
  if uri.query && uri.query.length > 0
    uri.query += '&' + query
  else
    uri.query = query
  end
end

request = Net::HTTP::Get.new(uri.request_uri)
# Request headers
request['Ocp-Apim-Subscription-Key'] = '{subscription key}'
# Request body
request.body = "{body}"

response = Net::HTTP.start(uri.host, uri.port, :use_ssl => uri.scheme == 'https') do |http|
    http.request(request)
end

puts response.body