How to call the endpoint

URL	Description
Compare	This endpoint is used to determine whether the face in two different images are the same or not.

Compare Request

This details the fields of a facial comparison compare request.

Property

Mandatory

Description

Current (file)

🔒

The Current element is the image captured from the device camera. It has to be a file rather than a text. When using the facial comparison endpoint, the Current image can be uploaded from the device. This element is compulsory, it cannot be removed or left empty.

- Required

File must be either JPEG, PNG or BMP

Please ensure that the image presented is smaller than 1.5Mb. If an image larger than this is presented, the endpoint will compress the image (ensuring that the solution works) however this will have a detrimental effect on the response time.]()

Comparison (file)

🔒

The Comparison is the image to be compared against the Current image. It has to be a file rather than a text. When using the facial comparison endpoint, the Comparison image can be uploaded from the device. This element is compulsory, it cannot be removed or left empty.

-Required

File must be either JPEG, PNG or BMP

Please ensure that the image presented is smaller than 1.5Mb. If an image larger than this is presented, the endpoint will compress the image (ensuring that the solution works) however this will have a detrimental effect on the response time.

ClientReference (string)

The Client Reference identifies this call for your reference.

Compare Response

Facial Comparison Full Response Example 1:

{
  "isMatch": true,
  "confidence": 100
}

Facial Comparison Full Response Example 2:

{
  "isMatch": false,
  "confidence": 12
}

This table describes the properties of the response.

Property Name	Description
isMatch (Boolean)	Represents whether the uploaded images match each other: true = match, false = not a match. This is based on the confidence score returned, >= 85 will return true, <85 will return false
confidence (int)	A score of 0 - 100 percentage, 0 indicates no match and 100 indicates 100% match

200The comparison was performed and results returned

400The request is invalid

401The request is unauthorized

415The request has provided an unsupported media type

500The request failed to process request