Endpoint
Corpo da requisição
Campos da requisição
| Campo | Tipo | Obrigatório | Descrição |
|---|---|---|---|
source_image | string | Sim | Imagem base em formato base64. |
target_image | string | Sim | Imagem que será comparada com a imagem base. |
threshold | number | Não | Similaridade mínima para considerar as faces compatíveis. Aceita valores de 0 a 100. O padrão é 80. |
Formato das imagens
As imagens devem ser enviadas em base64. Exemplo com prefixo MIME:Limite de similaridade
O campothreshold define a similaridade mínima exigida para considerar a comparação como compatível.
Exemplo:
matched será true.
Se for menor, o campo matched será false.
Exemplo de resposta compatível
Exemplo de resposta não compatível
Campos da resposta
| Campo | Tipo | Descrição |
|---|---|---|
result.id | string | Identificador da validação. |
result.status | string | Status da validação. |
result.test | boolean | Indica se a validação foi executada em ambiente de teste. |
result.cost.total | number | Valor total da validação. |
result.cost.charged | number | Valor debitado. |
result.cost.refunded | number | Valor estornado, quando aplicável. |
result.timing.total | number | Tempo total da validação em segundos. |
result.comparison.matched | boolean | Indica se as faces foram consideradas compatíveis. |
result.comparison.similarity | number | Percentual de similaridade entre as faces. |
result.comparison.confidence | number | Menor confiança detectada entre as faces comparadas. |
result.comparison.threshold | number | Similaridade mínima usada na validação. |
result.comparison.source_face | object | Dados da face detectada na imagem base. |
result.comparison.target_face | object | Dados da face detectada na imagem comparada. |
result.comparison.unmatched_faces | number | Quantidade de faces detectadas que não foram compatíveis. |
Chamada de teste
A comparação facial pode ser executada em ambiente de teste sem consumir saldo. Consulte a página de ambiente de teste:Ambiente de teste
Veja como habilitar chamadas de teste usando o header correto.

