Face Compare 1:1 [application/json]

POST

https://mostqiapi.com/process-image/biometrics/face-compare

face compareface match

Last modified:2024-11-08 11:27:38

Request

Header Params

Authorization

string

required

Token de autorização obtido no método user/authenticate.

Example:

Bearer {{bearer_token}}

Body Params application/json

faceFileBase64A

string <base64>

optional

🔸Requerido quando o parâmetro faceFileUrlA não é informado.
Binário do arquivo a ser processado, codificado em string de texto conforme o padrão RFC 4648 usando a codificação base64.

faceFileBase64B

string <base64>

optional

🔸Requerido quando o parâmetro faceFileUrlB não é informado.
Binário do arquivo a ser processado, codificado em string de texto conforme o padrão RFC 4648 usando a codificação base64.

faceFileUrlA

string

optional

🔸Requerido quando o parâmetro faceFileBase64A não é informado. Url pública do arquivo a ser processado.

faceFileUrlB

string

optional

🔸Requerido quando o parâmetro faceFileBase64B não é informado. Url pública do arquivo a ser processado.

faceFilePasswordA

string <base64>

optional

🔸Requerido caso o arquivo enviado no parâmetro faceFileBase64A ou faceFileUrlA seja um PDF criptografado por senha. A senha deve ser codificada em uma string base64, pois PDFs permitem que as senhas sejam dados binários.

faceFilePasswordB

string <base64>

optional

🔸Requerido caso o arquivo enviado no parâmetro faceFileBase64B ou faceFileUrlB seja um PDF criptografado por senha. A senha deve ser codificada em uma string base64, pois PDFs permitem que as senhas sejam dados binários.

Example

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

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

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

Lista contendo o resultado do método (consulte na documentação específica de cada um).

distances

array[number <float>]

float

deprecated

Lista contendo a medida de distância entre as duas faces enviadas. Quanto menor este valor maior é a similaridade. (Legado)

similarity

number <float>

required

Campo com o score de similaridade entre as faces comparadas. É normalizado no intervalo de 0.0 (menor score) à 1.0 (maior score). Quanto maior o score, maior a similaridade entre as faces.

>= 0<= 1

requestId

string

required

Código único de identificação da solicitação ao servidor, que será registrado no histórico de consumo dos serviços.

elapsedMilliseconds

integer

required

Tempo de duração do processamento em milissegundos.

status

object

required

Objeto contendo o código de status e a mensagem de resposta.

message

string | null

required

Mensagem de retorno de status. Veja os valores possíveis nas mensagens de erro do mostQI.

code

string

required

Código de status interno. Veja os valores possíveis nas mensagens de erro do mostQI.

errors

array [object {2}] | null

required

Lista de objetos do tipo Error, o formato é variável.

Example

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

🟠401R117 Invalid authorization data

🔴500E100 The request could not be processed

Modified at 2024-11-08 11:27:38

Face Compare 1:1 [multipart/form-data]

Face Compare 1:N