Face Compare 1:1 [application/json]

Request

Header Params

Authorization

string

required

Authorization token obtained in the Authentication/Authenticate method

Example:

Bearer {{bearer_token}}

Body Params application/json

faceFileBase64A

string

optional

🔸 Required when the faceFileUrlA parameter is not provided.
Binary of the file to be processed, encoded in text string according to RFC3548 standard using base64 encoding.

faceFileBase64B

string

optional

🔸 Required when the faceFileUrlB parameter is not provided.
Binary of the file to be processed, encoded in text string according to RFC3548 standard using base64 encoding.

faceFileUrlA

string

optional

🔸 Required when thefaceFileBase64A parameter is not provided. Public URL of the file to be processed.

faceFileUrlB

string

optional

🔸 Required when the faceFileBase64B parameter is not provided. Public URL of the file to be processed.

faceFilePasswordA

string <base64>

optional

🔸 Required if the file submitted in the faceFileBase64A or faceFilePasswordA parameter is a password-encrypted PDF. The password must be encoded as a base64 string, as PDFs allow passwords to be binary data.

faceFilePasswordB

string <base64>

optional

🔸 Required if the file submitted in the faceFileBase64B or faceFileUrlB parameter is a password-encrypted PDF. The password must be encoded as a base64 string, as PDFs allow passwords to be binary data.

Example

{
  "faceFileBase64A": "",
  "faceFileBase64B": "",
  "faceFileUrlA": "",
  "faceFileUrlB": "",
  "faceFilePasswordA": "",
  "faceFilePasswordB": ""
}

Request samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request POST 'https://mostqiapi.com/process-image/biometrics/face-compare' \
--header 'Authorization: Bearer ' \
--header 'Content-Type: application/json' \
--data-raw '{
    "faceFileBase64A": "",
    "faceFileBase64B": "",
    "faceFileUrlA": "",
    "faceFileUrlB": "",
    "faceFilePasswordA": "",
    "faceFilePasswordB": ""
}'

Responses

🟢200Ok

application/json

Body

result

object

required

distances

array[number <float>]

deprecated

A list containing the distance measurements between the two submitted faces. The smaller this value, the greater the similarity. (Legacy)

similarity

number <float>

required

Field with the similarity score between the compared faces. It is normalized in the range of 0.0 (lowest score) to 1.0 (highest score). The higher the score, the greater the similarity between the faces.

>= 0<= 1

requestId

string

required

Unique identifier code for the request to the server, which will be recorded in the service consumption history.

elapsedMilliseconds

integer

required

Processing duration time in milliseconds.

status

object

required

Object containing the status code and the response message.

code

string

required

Internal status code. See the possible values in the error messages of mostQI.

message

string | null

required

Status return message. See the possible values in the error messages of mostQI.

errors

array [object {2}] | null

required

List of objects of type Error; the format is variable.

Example

{
  "result": {
    "distances": [
      0.81
    ],
    "similarity": 0.19
  },
  "requestId": "eyDwui1750WVJTkno8VZD",
  "elapsedMilliseconds": 493,
  "status": {
    "message": "Ok",
    "code": "200",
    "errors": null
  }
}

🟠401R117 Invalid authorization data

🟠400R101 A specified parameter is wrong

🔴500E100 The request could not be processed