Documentação Técnica

Descrição

A API de Facematch é responsável por fazer uma comparação biométrica entre 2 imagens que contenham faces, geralmente uma imagem de um documento com a foto de rosto e uma segunda imagem, geralmente, uma selfie. A partir desta comparação retornar um percentual de similaridade entre as mesmas.

Tabela de preços para essas chamada

Consultas Realizadas no MêsValor por consulta
1 - 10000R$ 0,160
10001 - 50000R$ 0,153
50001 - 100000R$ 0,144
100001 - 500000R$ 0,138
500001 - 1000000R$ 0,131
1000001 - 5000000R$ 133.000,00 (preço fixo)
5000001 e acimaEntre em contato

Parâmetros obrigatórios

Essa consulta contem parâmetros obrigatórios para o sucesso da consulta. A tabela abaixo detalha os campos necessários.

CampoDescrição do campoValores Possíveis do Campo
BASE_FACE_IMGstring base 64 que represente uma imagemqualquer texto
MATCH_IMGstring base 64 que represente uma imagemqualquer texto
BASE_FACE_IMG_URLurl que represente uma imagemqualquer texto
MATCH_IMG_URLurl que represente uma imagemqualquer texto

Abaixo está um exemplo de como realizar a chamada com parâmetros obrigatórios:

{
	"Parameters": "[BASE_FACE_IMG=qualquer texto]",
}

Parâmetros opcionais

Essa chamada permite a passagem de parâmetros opcionais para apoiar o processo de consulta. A tabela abaixo detalha os campos opcionais.

CampoDescrição do campoValores Possíveis do Campo
PrivateBaseFaceUrlFlag que indica que a BaseFaceUrl é uma URL privadaTrue
PrivateMatchImgUrlFlag que indica que a MatchImgUrl é uma URL privadaTrue

Abaixo está um exemplo de como utilizar um dos parâmetro opcionais:

{
	"Parameters": ",[PrivateBaseFaceUrl=True][BASE_FACE_IMG=qualquer texto]",
}

Códigos e Descrições de Status

CodeMessage
-826The provided image is above 15mb
-824Access Denied, Check your credentials
-816The images sent are identical!
-814One request key is wrong
-806The provided image URL is not OK
-801An error occurred during the Face Match execution
-800The face pictures does not match
80Face picture match
Language
Credentials
Click Try It! to start a request and see the response here!