Ctrlk
For the complete documentation index, see llms.txt. This page is also available as Markdown.

Transação

Os webhooks de transação são usados para comunicar atualizações de status da transação ao cliente-servidor.

Configurando o webhook

Existem duas maneiras de configurar um webhook: vinculando-o a um modelo de consulta ou inserindo-o diretamente na requisição ao iniciar uma transação. Para configurar a URL padrão do webhook de um modelo de consulta, navegue até a Modelos de Consulta menu no CAF Trust Platform e selecione o modelo desejado e edite o Webhook campo.

  • Cada Modelo de Consulta criado no CAF Trust Platform precisará de uma URL de callback atribuída para os webhooks. Essa URL pode ser diferente entre os modelos ativos ou a mesma.

  • A URL configurada deve estar pronta para receber uma requisição POST após a execução de um serviço do CAF.

  • A /transação o endpoint de serviço pode receber como parâmetro opcional _callbackUrl com cada transação ou requisição de onboarding. A URL padrão configurada no modelo de consulta associado será ignorada ao usar este parâmetro em qualquer requisição POST individual. Para mais detalhes sobre essa substituição, vá para a Página de criação de transação.

Testador de Webhook **** e Request Bin são ferramentas úteis para receber chamadas de webhook. Você pode usá-las para gerar uma URL de webhook e usar essa URL em quaisquer requisições do Postman que exijam que você especifique uma URL de webhook; em seguida, use os sites para inspecionar o conteúdo de quaisquer webhooks que eles tenham recebido.

Notificações de webhook

Você receberá uma notificação via webhook nos seguintes eventos:

  • Nova transação de onboarding web

Especificamente, no onboarding web, uma transação é iniciada quando um usuário conclui o fluxo, e você receberá uma notificação do tipo process_started. Isso significa que os documentos foram capturados e enviados para revisão.

  • Enviado para documentscopy

Quando o documento tiver sido enviado para o documentscopy, você receberá uma notificação do tipo documentscopy_requested. O status da transação permanece PROCESSING até que o documentscopy seja concluído.

  • Alteração de status

Quando o status da transação mudar, você receberá uma status_updated notificação.

O status de uma transação é definido com base nas validações configuradas no modelo de consulta.

Parâmetros de resposta do webhook

Nome
Tipo
Descrição

tipo*

String

Tipo do evento (process_started, status_updated ou documentscopy_requested)

relatório*

String

Identificador do relatório (suporte ao fluxo legado). Se a transação não tiver relatório, o valor retornará como 000000000000000000000000

uuid*

String

Identificador da transação

status*

String

Status da transação

data*

String

Data em que o webhook é enviado no formato UTC

onboardingId

String

Se disponível, o identificador do link de onboarding usado na captura de dados.

templateId

String

Identificador do modelo de consulta da transação, se existir

statusReasons

Array

Motivos do status

statusReasons[x].category

String

Categoria do motivo

statusReasons[x].code

String

Código do motivo

statusReasons[x].status

String

Status do motivo: ("VALID", "INVALID")

statusReasons[x].resultStatus

String

Resultado do status: ("APPROVED", "REPROVED", "PENDING")

statusReasons[x].description

String

Descrição do motivo

Exemplo de envio do webhook:

Tratamento de erros

Se não conseguirmos nos comunicar com o seu webhook, faremos até 5 tentativas em no máximo 5 horas. Durante o intervalo entre as requisições, alterações podem ocorrer no status da transação. Caso as notificações sejam entregues fora de ordem cronológica, o status pode não estar majoritariamente atualizado. Portanto, a recomendação é considerar o atributo date e sempre consultar a versão mais recente da transação.

Atualizado