Face Comparison API Guide

Face Comparing API

Check whether two faces belong to the same person. The API returns a match result and confidence level, along with the bounding box and quality of each compared face.

Select version

Download document

Postman Swagger

Download sample code

C# Node Laravel Java PHP

Overview

Check the possibility that two faces refer to the same individual. The API returns the confidence level of matched faces along with the bounding box and quality. If the source image contains multiple faces, by default the API takes the highest-quality face and compares it against every face in the target image.

Details

Request URL

https://faceapi.mxface.ai/api/v3/Face/verify

Method type

POST

Headers

Content-Type : application/json

Subscriptionkey : xxxxxxxxxxx

Request body

{
  "encoded_image1": "/9j/4AAQSkZJRgABAQAAAQABAA.........",
  "encoded_image2": "/9j/4AAQSkZJRgABAQAAAQABAAD/2wBDAAMCAgMCAgMDAwM........"
}

Request parameters

encoded_image1 YesString

base64 encoded string of source image.

encoded_image2 YesString

base64 encoded string of target image.

compareAllFaces Nobool

Default is false. If true the API compares all faces from the source image with all faces of the target image.

qualityThreshold NoInt

Optional integer between 21 and 100. If supplied, uploaded face quality is compared against it, otherwise the quality check follows the defined MxFace standard.

minimumDistanceBetweenEyeThreshold NoInt

Set distance between eyes

Response body

{
  "matchedFaces": [
    {
      "matchResult": 1,
      "image1_face": {
        "faceRectangle": {
          "x": 30,
          "y": 0,
          "height": 1860,
          "width": 1532
        },
        "points": [
          { "x": 58.2854, "y": -42.453003 },
          { "x": 1562.8524, "y": -20.026917 },
          { "x": 30.252747, "y": 1838.2557 },
          { "x": 1534.8197, "y": 1860.6819 }
        ],
        "quality": 94.401535
      },
      "image2_face": {
        "faceRectangle": {
          "x": 30,
          "y": 0,
          "height": 1860,
          "width": 1532
        },
        "points": [
          { "x": 58.2854, "y": -42.453003 },
          { "x": 1562.8524, "y": -20.026917 },
          { "x": 30.252747, "y": 1838.2557 },
          { "x": 1534.8197, "y": 1860.6819 }
        ],
        "quality": 94.401535
      }
    }
  ]
}

Response parameters

matchResult int

If the face matching score is above 60 the value is 1. If the score is below 60 the value is 0.

image1_face object

Boundary of face 1

image2_face object

Boundary of face 2

faceRectangle object

Boundary of the face

height int

Height of face

width int

Width of face

x int

x-edge of face

y int

y-edge of face

quality float

Quality score of image between 1 and 100