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 - DetectLiveness SingleModal

Performs liveness detection on a target face in a sequence of images of the same modality (e.g. color or infrared), and returns the liveness classification of the target face as either ‘real face’, ‘spoof face’, or ‘uncertain’ if a classification cannot be made with the given inputs.

 

There are three ways to specify a 'focus face':

  1. The caller specifies the focus face rectangle region on all images in the input payload.
  2. The caller specifies the focus face rectangle region on a single image, and the same face is tracked across the sequence of images by the service.
  3. The caller specifies no focus face region in the input payload, this would result in the service focusing on the largest face seen in the first image of the image sequence.

 

The request content-type should be specified as \"multipart/form-data\" consisting of:

  1. The metadata of the payload specified in an \"application\\json\" format with the 'name' header value set to 'Metadata'.
  2. The image/video streams listed in the same order as in the metadata, in an \"application/octet-stream\" format with the 'name' header value set to 'Content' and the 'filename' header value set to corresponding file name of the stream.

 

Additional considerations:

  • No images will be stored on the server.
  • JPEG, PNG, GIF(the first frame), and BMP format are supported for images.
  • WEBP format is supported for videos.
  • The allowed image file size is from 1KB to 6MB.
  • The allowed video file size is from 1KB to 25MB.
  • The minimum detectable face size is 128x128 pixels in an image no larger than 1920x1080 pixels. Images with dimensions higher than 1920x1080 pixels will need a proportionally larger minimum face size.
  • For optimal results, please use faces that are: frontal, clear, and with a minimum size of 200x200 pixels(100 pixels between eyes).

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

(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

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

Method: POST, RequestUri: [Uri], Headers:
{
  Accept: application/json
  Content-Type: multipart/form-data; boundary=\"23ac264d-6a58-4f66-929d-d4fd1fc4a7fa\"
}
--23ac264d-6a58-4f66-929d-d4fd1fc4a7fa
Content-Type: application/json; charset = utf-8
Content-Disposition: form-data; name = Metadata
{
  "metadata": {
    "imageType": 0,
    "imageData": [
      {
        "activeIlluminationInformation": {
          "illuminatedColor": "Red"
        },
        "fileName": "video.webp",
        "frameNumber": 0,
        "imageCreationTimeInMilliSeconds": 2309856,
        "targetFaceRectangle": {
          "top": 50,
          "left": 50,
          "width": 100,
          "height": 100
        },
        "imageCropOffsets": {
          "cropOffsetX": 100,
          "cropOffsetY": 100,
          "fullFrameImageWidth": 1920,
          "fullFrameImageHeight": 1080
        }
      },
      {
        "activeIlluminationInformation": {
          "illuminatedColor": "Green"
        },
        "fileName": "video.webp",
        "frameNumber": 1,
        "imageCreationTimeInMilliSeconds": 2309891,
        "targetFaceRectangle": {
          "top": 46,
          "left": 48,
          "width": 100,
          "height": 100
        },
        "imageCropOffsets": {
          "cropOffsetX": 98,
          "cropOffsetY": 96,
          "fullFrameImageWidth": 1920,
          "fullFrameImageHeight": 1080
        }
      }
    ]
  }
}
--23ac264d-6a58-4f66-929d-d4fd1fc4a7fa
Content-Disposition: form-data; name = Content; filename = video.webp
Content-Type: application/octet-stream
[Stream Data]

Response 200

Success

{
  "livenessDecision": "spoofface",
  "targetFaceRectangle": {
    "top": 50,
    "left": 50,
    "width": 100,
    "height": 100
  },
  "targetFileName": "video.webp",
  "targetFrameNumber": 1,
  "modelVersionUsed": "2020-02-15-preview.01"
}

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.

apim-face-detect-liveness-test2-westus - APIs - Microsoft Azure.html

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.

Code samples

@ECHO OFF

curl -v -X POST "https://norwayeast.api.cognitive.microsoft.com/face/v1.1-preview.1/detectLiveness/singleModal?model-version={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["model-version"] = "{string}";
            var uri = "https://norwayeast.api.cognitive.microsoft.com/face/v1.1-preview.1/detectLiveness/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/detectLiveness/singleModal");

            builder.setParameter("model-version", "{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
            "model-version": "{string}",
        };
      
        $.ajax({
            url: "https://norwayeast.api.cognitive.microsoft.com/face/v1.1-preview.1/detectLiveness/singleModal?" + $.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://norwayeast.api.cognitive.microsoft.com/face/v1.1-preview.1/detectLiveness/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:@"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/detectLiveness/singleModal');
$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
    '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
    '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/detectLiveness/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
    '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/detectLiveness/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/detectLiveness/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['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