Webhooks Onboarding

Esta página tem como objetivo consolidar e descrever os gatilhos (webhooks) disponíveis no fluxo de Onboarding/KYC, que devem ser configurados pelos clientes para o correto acompanhamento dos eventos relacionados ao processo de abertura e validação cadastral.

Por meio desses webhooks, os sistemas integrados podem receber notificações sobre as mudanças de status, aprovações, reprovações e outras etapas relevantes do processo de onboarding, permitindo que cada cliente implemente suas regras de negócio e automações a partir desses eventos.

Fluxo de integração Opção 1

Fluxo para clientes que possuem uma jornada faseada do processo de KYC. Onde é realizado o Background Check primeiro e depois a documentoscopia.

Evento	Descriçãio
onboarding-backgroundcheck	Informa o status do processo de Background Check
onboarding-documentscopy	Informa o status do processo de Documentoscopia.
webhook onboarding-file	Envia a URL que contém os documentos enviados pelo cliente na jornada. Será enviado após o webhook onboarding-documentscopy com status Processing.
onboarding-proposal	Resultado da proposta, status Approved ou Reproved.
onboarding-create	Criação da conta no BaaS. O Status será sempre CONFIRMED ou ERROR caso ocorra algum erro na criação.

Fluxo de integração Opção 2

Fluxo para clientes que possuem uma jornada contínua do processo de KYC. Nesse fluxo é realizado a Documentoscopia primeiro e depois o Background Check.

Código	Descrição
onboarding-documentscopy	Informa o status do processo de Documentoscopia.
webhook onboarding-file	Envia a URL que contém os documentos enviados pelo cliente na jornada. Será enviado após o webhook onboarding-documentscopy com status Processing.
onboarding-backgroundcheck	Informa o status do processo de Background Check.
onboarding-proposal	Resultado da proposta, status Approved ou Reproved.
onboarding-create	Criação da conta no BaaS. O Status será sempre CONFIRMED ou ERROR caso ocorra algum erro na criação.

📘
Para detalhes sobre o fluxo acesse a página de Criação de Contas (Onboarding)