Add Faces [application/json]

Request

Header Params

Authorization

string

required

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

Example:

Bearer {{bearer_token}}

Body Params application/json

database

string

required

Nome do banco de dados de faces.

fileBase64

string <base64>

required

Binário do arquivo a ser processado, codificado em string de texto de acordo com o padrão RFC 4648 usando a codificação base64.

Match pattern:

RFC3548

Example

{
  "database": "",
  "fileBase64": ""
}

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/database/add-faces' \
--header 'Authorization: Bearer ' \
--header 'Content-Type: application/json' \
--data-raw '{
    "database" : "",
    "fileBase64": ""
}'

Responses

🟢200OK

application/json

Body

result

array [object {2}]

required

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

faceId

string

required

ID único da face cadastrada no banco de dados de faces especificado na entrada.

score

number <float>

required

Score de confiança da face cadastrada. É normalizado no intervalo de 0.0 (menor score) à 1.0 (maior score) e representa a qualidade da face.

>= 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

Example

{
  "result": [
    {
      "faceId": "9acdr821-1d72-46ba-878f-5ced94ce906c",
      "score": 1
    }
  ],
  "requestId": "c36GUi4hCuCCta9ZNjZev",
  "elapsedMilliseconds": 2775,
  "status": {
    "message": "Ok",
    "code": "200",
    "errors": null
  }
}

🟠401R117 Invalid authorization data

🔴500E100 The request could not be processed