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
  • Japan East - japaneast.api.cognitive.microsoft.com
  • Japan West - japanwest.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
  • South Africa North - southafricanorth.api.cognitive.microsoft.com
  • South Central US - southcentralus.api.cognitive.microsoft.com
  • Southeast Asia - southeastasia.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
  • UAE North - uaenorth.api.cognitive.microsoft.com

Face - Compare

Compare two faces from source image and target image based on a their similarity.

This API is for 1:1 face comparison. If there are multiple faces in the images, only the largest face in each image will be used for comparison. The face rectangle of used faces will be returned, as well as a confidence score, a flag indicating if the two faces are matched based on internal confidence threshold and the detection/recognition models used.
No image or face feature vectors will be stored.

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

Open API testing console

Request URL

Request parameters

(optional)
string

The 'detectionModel' to be used to detect face. Supported 'detectionModel' values include "detection_01", "detection_02" and "detection_03". If no detectionModel is specified, the latest model will be used.

(optional)
string

The 'recognitionModel' to be used for face comparison. Supported 'recognitionModel' values include "recognition_01", "recognition_02", "recognition_03" or "recognition_04". If no recognitionModel is specified, the latest model will be used.

Request headers

string
Media type of the body sent to the API.
string
Subscription key which provides access to this API. Found in your Cognitive Services accounts.

Request body

o compare either multipart/form-data of two image file binaries or a JSON payload with two image URLs. Note only one source image and one target image is supported. If you provide more, you'll get an error.

Content-Disposition: form-data; name="source"; Content-Type: application/octet-stream

Content-Disposition: form-data; name="target"; Content-Type: application/octet-stream
{
    "sourceImageUrl": "https://facev1csdev.azureedge.net/twoFaces.jpg",
    "targetImageUrl": "https://facev1csdev.azureedge.net/twoFaces.jpg"
}

Response 200

Success

{
    "targetImageFace": {
        "faceRectangle": {
            "top": 36,
            "left": 22,
            "width": 57,
            "height": 57
        },
        "confidence": 1.0,
        "isIdentical": true
    },
    "sourceImageFace": {
        "faceRectangle": {
            "top": 36,
            "left": 22,
            "width": 57,
            "height": 57
        }
    },
    "detectionModel": "detection_01",
    "recognitionModel": "recognition_03"
}

Response 400

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 BadRequest, Filename specified in 'Metadata' is not found in the 'Content' 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, Face not found across sufficient frames. BadRequest, Face is too blurred and cannot be clearly seen. BadRequest, Face is over exposed and cannot be clearly seen. BadRequest, Face is under exposed and cannot be clearly seen. BadRequest, Face is not frontal and liveness classification cannot be run on face.

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.

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

Response 429

Rate limit is exceeded. Try again in 26 seconds.

Response 500

Code samples

@ECHO OFF

curl -v -X POST "https://*.cognitiveservices.azure.com/face/v1.1-preview.1/compare?detectionModel={string}&recognitionModel={string}"
-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("Ocp-Apim-Subscription-Key", "{subscription key}");

            // Request parameters
            queryString["detectionModel"] = "{string}";
            queryString["recognitionModel"] = "{string}";
            var uri = "https://*.cognitiveservices.azure.com/face/v1.1-preview.1/compare?" + 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://*.cognitiveservices.azure.com/face/v1.1-preview.1/compare");

            builder.setParameter("detectionModel", "{string}");
            builder.setParameter("recognitionModel", "{string}");

            URI uri = builder.build();
            HttpPost request = new HttpPost(uri);
            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
            "detectionModel": "{string}",
            "recognitionModel": "{string}",
        };
      
        $.ajax({
            url: "https://*.cognitiveservices.azure.com/face/v1.1-preview.1/compare?" + $.param(params),
            beforeSend: function(xhrObj){
                // Request headers
                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://*.cognitiveservices.azure.com/face/v1.1-preview.1/compare";
    NSArray* array = @[
                         // Request parameters
                         @"entities=true",
                         @"detectionModel={string}",
                         @"recognitionModel={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:@"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://*.cognitiveservices.azure.com/face/v1.1-preview.1/compare');
$url = $request->getUrl();

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

$request->setHeader($headers);

$parameters = array(
    // Request parameters
    'detectionModel' => '{string}',
    'recognitionModel' => '{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
    'Content-Type': 'multipart/form-data',
    'Ocp-Apim-Subscription-Key': '{subscription key}',
}

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

try:
    conn = httplib.HTTPSConnection('*.cognitiveservices.azure.com')
    conn.request("POST", "/face/v1.1-preview.1/compare?%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
    'Content-Type': 'multipart/form-data',
    'Ocp-Apim-Subscription-Key': '{subscription key}',
}

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

try:
    conn = http.client.HTTPSConnection('*.cognitiveservices.azure.com')
    conn.request("POST", "/face/v1.1-preview.1/compare?%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://*.cognitiveservices.azure.com/face/v1.1-preview.1/compare')

query = URI.encode_www_form({
    # Request parameters
    'detectionModel' => '{string}',
    'recognitionModel' => '{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['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