Webhook Facematch v2

Sempre que ocorrer uma alteração de status da transação, o Webhook de Facematch irá enviar uma notificação para uma URL que deverá ser implementada no lado do integrador.

Para cadastrar as URLs é necessário contatar seu gerente de conta informando os dados da tabela abaixo:

NomeDescrição
Nome ClienteNome fantasia do cliente
URLURL que será chamada quando houver uma alteração na transação
TokenO token informado deverá ser uma chave secreta enviada nas chamadas de Webhook, no Header "Authorization: Bearer {Token}"

Response

POST {URL cadastrada} HTTP/1.1
Content-Type: application/json; charset=utf-8
{
    "scoreSimilarity": 0.99,
    "isMatch": true,
    "document": "12345678909",
    "transactionId": "8f10a24cac2b4ce78819d78bc1deb87b",
    "identifierId": "testePDTApiHML",
    "transactionStatus": "Done",
    "transactionStatusCode": 1,
    "observation": "Multiple faces detected on request."
}

Importante: Se a URL do integrador retornar qualquer Status HTTP diferente de 200 (Ok), será feita outra tentativa de notificar a transação.

Dicionário de variáveis

NomeDescriçãoTipoTamanhoAnulável
identifierIDO valor enviado na transação será retornado na respostaString-True
transactionIdIdentificador da transação gerada pela Plataforma DataTrustString-False
documentO valor enviado na transação será retornado na respostaString11False
scoreSimilarityOs valores do campo “scoreSimilarity “podem variar entre 0 e 1.Double1True
isMatchIndica se as fotos são da mesma pessoa ou nãoBool-True
transactionStatusStatus da transação. Possíveis status:
- Success
- Processing
- Error
String-False
transactionStatusCodeIntFalse
errorMessageCampo retornado caso aconteça qualquer tipo de erro no processamento da TransaçãoString-True
observationCampo retornado caso seja necessário informar alguma observação no request, como por exemplo múltiplas faces detectadas no requestString[]-Tru

Importante: Os valores do campo “scoreSimilarity “podem variar entre 0 e 1. Recomendamos aprovação nos casos em que o retorno desse campo seja >=0,8.