Face Match API | Post Request

Overview

Face Match API is used for applications where you need to determine if two faces belong to the same person or not. The API accepts two faces as inputs (using the tag img_1 & img_2) and provides the result if the images match or not.

Image Requirement

  1. Please refer to the article “Image Quality for Facial Recognition” for best practices.
  2. We recommend an image resolution no higher than 1024x, since it could slow down the request process. Supported image formats are JPEG/PNG format.

Request URL

http://www.facexapi.com/match_faces

Note:  If you are using pictures which contain more than one face per image and you need to use bounding box, please refer to the article “The Post Request | Face Match | Bounding Box

Header

Type

Description

user_id String Your valid User ID

(as shown in your user portal when you log in)

content-type multipart/form-data (if using image file)

application/json (if using Base64/URL)

Note: Your User ID will be valid for Face Match API only if you have an active FaceAPI plan

Body

Fields

Type

Description

img_1 File or  String An image file, base64 or URL of the first person
img_2 File or  String An image file, base64 or URL of the Second person

Result

The API Returns two results

Fields

Value

Description

Result Match

or

Not a Match

The API provides a result based on facial vector comparison

on whether the two faces are a match or not

Euclidian Distance 0 – 0.9 The Euclidian distance between the vectors of the two images.

If the distance is less than the current threshold (0.6): Match

If the distance is more than the current threshold(0.6): Not a match

 

Related Articles
Post a Comment