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
Face - DetectLivenessWithVerify SingleModal
Detects liveness of a target face in a sequence of images of the same stream type (e.g. color) and then compares with VerifyImage to return confidence score for identity scenarios.
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 3Request URL
Request parameters
(optional) The liveness model to be used for the classification. Choose one from the following { "2020-02-15-preview.01", "latest" }, where "latest" refers to the "2020-02-15-preview.01" model. If this value is not specified then the "latest" model would be chosen by default.
Request headers
Request body
Response 200
Success
{
"livenessDecision": "uncertain",
"targetFaceRectangle": {
"top": 0,
"left": 0,
"width": 0,
"height": 0
},
"targetFileName": "string",
"targetTimeOffsetWithinFile": 0,
"targetImageType": "color",
"modelVersionUsed": "liveness_2020_02_15_Preview_01",
"verifyResult": {
"faceRectangle": {
"top": 0,
"left": 0,
"width": 0,
"height": 0
},
"matchConfidence": 0.0,
"isIdentical": true
}
}Response 400
BadRequest, Feature not enabled for subcription-id, please contact azure sales for more information.
BadRequest, Error in parsing multipart/form-data request, please check the example on the documentation website for reference.
BadRequest, Incorrect model-version. Please specify one of the valid model versions found at
BadRequest, A value for the 'Metadata' property was not provided. Required header example: Content-Type: application/json; charset=utf-8 Content-Disposition: form-data; name=Metadata
BadRequest, A value for the 'Content' property was not provided. Required header example: Content-Type: application/octet-stream; Content-Disposition: form-data; name=Content; filename=sample.jpg
BadRequest, Multiple file with the same 'FileName' found in 'Content', they have to be unique
BadRequest, File name specified in 'Metadata' is not found in the 'Content', required 'Content' header example: Content-Type: application/octet-stream; Content-Disposition: form-data; name=Content; filename=sample.jpg
BadRequest, The time offset specified in 'Metadata' exceeds the duration of the file.
BadRequest, Target face rectangle specified is out of range and not contained within image.
BadRequest, Decoding error, content not in expected format.
BadRequest, Image size is too large.
BadRequest, Image size is too small.
BadRequest, Face not found within target rectangle.
BadRequest, Multiple faces found within target rectangle.
BadRequest, Multiple frames of the same image type is required to perform liveness detection.
BadRequest, Face not found across sufficient frames.
BadRequest, A value for the 'VerifyImage' property was not provided. Required header example: Content-Type: application/octet-stream; Content-Disposition: form-data; name=ComparisonImage; filename=sample.jpg
BadRequest, Face not found within verify image.
BadRequest, Multiple faces found within verify image.
BadRequest, Only the color modality is supported.
BadRequest, Actively illuminated image pairs are required to perform liveness detection. Each pair of images should have the imageProperties.Description field set to illumination_dark and illumination_bright and ordered by the ImageTimestampInMilliseconds to be sequential.
BadRequest, Face is not frontal and liveness classification cannot be run on face.
BadRequest, The mouth region is not visible in image.
BadRequest, The eye region is not visible in image.
BadRequest, The same face identity is not seen across all images.
BadRequest, Excessive blurriness detected on face image.
BadRequest, Excessive brightness detected on face image.
BadRequest, Mask detected on face image.
Response 401
Invalid subscription Key or user/plan is blocked.
Response 403
Out of call volume quota. Quota will be replenished in 2 days.
Response 408
OperationTimeOut.
Response 415
Invalid Media Type.
Response 429
Rate limit is exceeded. Try again in 26 seconds.
Code samples
@ECHO OFF
curl -v -X POST "https://norwayeast.api.cognitive.microsoft.com/face/v1.1-preview.1/detectLivenessWithVerify/singleModal?model-version={string}"
-H "apim-subscription-id: "
-H "apim-product-id: "
-H "timestamp: "
-H "request-time: "
-H "apim-request-id: "
-H "client-request-id: "
-H "cors: "
-H "Content-Type: multipart/form-data"
-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("apim-subscription-id", "");
client.DefaultRequestHeaders.Add("apim-product-id", "");
client.DefaultRequestHeaders.Add("timestamp", "");
client.DefaultRequestHeaders.Add("request-time", "");
client.DefaultRequestHeaders.Add("apim-request-id", "");
client.DefaultRequestHeaders.Add("client-request-id", "");
client.DefaultRequestHeaders.Add("cors", "");
client.DefaultRequestHeaders.Add("Ocp-Apim-Subscription-Key", "{subscription key}");
// Request parameters
queryString["model-version"] = "{string}";
var uri = "https://norwayeast.api.cognitive.microsoft.com/face/v1.1-preview.1/detectLivenessWithVerify/singleModal?" + queryString;
HttpResponseMessage response;
// Request body
byte[] byteData = Encoding.UTF8.GetBytes("{body}");
using (var content = new ByteArrayContent(byteData))
{
content.Headers.ContentType = new MediaTypeHeaderValue("< your content type, i.e. application/json >");
response = await client.PostAsync(uri, content);
}
}
}
} // // 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/detectLivenessWithVerify/singleModal");
builder.setParameter("model-version", "{string}");
URI uri = builder.build();
HttpPost request = new HttpPost(uri);
request.setHeader("apim-subscription-id", "");
request.setHeader("apim-product-id", "");
request.setHeader("timestamp", "");
request.setHeader("request-time", "");
request.setHeader("apim-request-id", "");
request.setHeader("client-request-id", "");
request.setHeader("cors", "");
request.setHeader("Content-Type", "multipart/form-data");
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
"model-version": "{string}",
};
$.ajax({
url: "https://norwayeast.api.cognitive.microsoft.com/face/v1.1-preview.1/detectLivenessWithVerify/singleModal?" + $.param(params),
beforeSend: function(xhrObj){
// Request headers
xhrObj.setRequestHeader("apim-subscription-id","");
xhrObj.setRequestHeader("apim-product-id","");
xhrObj.setRequestHeader("timestamp","");
xhrObj.setRequestHeader("request-time","");
xhrObj.setRequestHeader("apim-request-id","");
xhrObj.setRequestHeader("client-request-id","");
xhrObj.setRequestHeader("cors","");
xhrObj.setRequestHeader("Content-Type","multipart/form-data");
xhrObj.setRequestHeader("Ocp-Apim-Subscription-Key","{subscription key}");
},
type: "POST",
// 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/detectLivenessWithVerify/singleModal";
NSArray* array = @[
// Request parameters
@"entities=true",
@"model-version={string}",
];
NSString* string = [array componentsJoinedByString:@"&"];
path = [path stringByAppendingFormat:@"?%@", string];
NSLog(@"%@", path);
NSMutableURLRequest* _request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:path]];
[_request setHTTPMethod:@"POST"];
// Request headers
[_request setValue:@"" forHTTPHeaderField:@"apim-subscription-id"];
[_request setValue:@"" forHTTPHeaderField:@"apim-product-id"];
[_request setValue:@"" forHTTPHeaderField:@"timestamp"];
[_request setValue:@"" forHTTPHeaderField:@"request-time"];
[_request setValue:@"" forHTTPHeaderField:@"apim-request-id"];
[_request setValue:@"" forHTTPHeaderField:@"client-request-id"];
[_request setValue:@"" forHTTPHeaderField:@"cors"];
[_request setValue:@"multipart/form-data" forHTTPHeaderField:@"Content-Type"];
[_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/detectLivenessWithVerify/singleModal');
$url = $request->getUrl();
$headers = array(
// Request headers
'apim-subscription-id' => '',
'apim-product-id' => '',
'timestamp' => '',
'request-time' => '',
'apim-request-id' => '',
'client-request-id' => '',
'cors' => '',
'Content-Type' => 'multipart/form-data',
'Ocp-Apim-Subscription-Key' => '{subscription key}',
);
$request->setHeader($headers);
$parameters = array(
// Request parameters
'model-version' => '{string}',
);
$url->setQueryVariables($parameters);
$request->setMethod(HTTP_Request2::METHOD_POST);
// 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
'apim-subscription-id': '',
'apim-product-id': '',
'timestamp': '',
'request-time': '',
'apim-request-id': '',
'client-request-id': '',
'cors': '',
'Content-Type': 'multipart/form-data',
'Ocp-Apim-Subscription-Key': '{subscription key}',
}
params = urllib.urlencode({
# Request parameters
'model-version': '{string}',
})
try:
conn = httplib.HTTPSConnection('norwayeast.api.cognitive.microsoft.com')
conn.request("POST", "/face/v1.1-preview.1/detectLivenessWithVerify/singleModal?%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
'apim-subscription-id': '',
'apim-product-id': '',
'timestamp': '',
'request-time': '',
'apim-request-id': '',
'client-request-id': '',
'cors': '',
'Content-Type': 'multipart/form-data',
'Ocp-Apim-Subscription-Key': '{subscription key}',
}
params = urllib.parse.urlencode({
# Request parameters
'model-version': '{string}',
})
try:
conn = http.client.HTTPSConnection('norwayeast.api.cognitive.microsoft.com')
conn.request("POST", "/face/v1.1-preview.1/detectLivenessWithVerify/singleModal?%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/detectLivenessWithVerify/singleModal')
query = URI.encode_www_form({
# Request parameters
'model-version' => '{string}'
})
if query.length > 0
if uri.query && uri.query.length > 0
uri.query += '&' + query
else
uri.query = query
end
end
request = Net::HTTP::Post.new(uri.request_uri)
# Request headers
request['apim-subscription-id'] = ''
# Request headers
request['apim-product-id'] = ''
# Request headers
request['timestamp'] = ''
# Request headers
request['request-time'] = ''
# Request headers
request['apim-request-id'] = ''
# Request headers
request['client-request-id'] = ''
# Request headers
request['cors'] = ''
# Request headers
request['Content-Type'] = 'multipart/form-data'
# 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