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:
Nome | Descrição |
---|---|
Nome Cliente | Nome fantasia do cliente |
URL | URL que será chamada quando houver uma alteração na transação |
Token | O 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
Nome | Descrição | Tipo | Tamanho | Anulável |
---|---|---|---|---|
identifierID | O valor enviado na transação será retornado na resposta | String | - | True |
transactionId | Identificador da transação gerada pela Plataforma DataTrust | String | - | False |
document | O valor enviado na transação será retornado na resposta | String | 11 | False |
scoreSimilarity | Os valores do campo “scoreSimilarity “podem variar entre 0 e 1. | Double | 1 | True |
isMatch | Indica se as fotos são da mesma pessoa ou não | Bool | - | True |
transactionStatus | Status da transação. Possíveis status: - Success - Processing - Error | String | - | False |
transactionStatusCode | Int | False | ||
errorMessage | Campo retornado caso aconteça qualquer tipo de erro no processamento da Transação | String | - | True |
observation | Campo retornado caso seja necessário informar alguma observação no request, como por exemplo múltiplas faces detectadas no request | String[] | - | 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.
Updated 2 months ago