Visão Geral
O onboarding KYC é uma etapa de validação cadastral utilizada para verificar se o tomador do crédito está apto a seguir no processo de emissão de contrato. Quando essa validação estiver habilitada para o produto contratado, o nosso sistema verifica se a pessoa já concluiu o onboarding e qual foi o resultado da análise.Fluxo do Processo
Etapas
- O cadastro é incluído por meio da API
/trabalhador/cadastrar-vinculo. - O valor da proposta de crédito, e demais informações, são incluídos por meio da API
/contrato/oferta-ativa/gerar-contrato. - Os dados da pessoa são encaminhados ao motor interno de KYC, responsável pelo enriquecimento cadastral, pela validação das informações e pela classificação de risco do cadastro.
- O resultado da análise é recebido pelo nosso sistema.
- Com o retorno de callback aprovado, o fluxo é liberado para a emissão de contrato.
- Caso não haja retorno com callback aprovado, a tentativa de emissão de contrato pelo endpoint correspondente retornará erro HTTP 400, com callbacks do motivo da reprovação.
Possíveis Resultados
Cadastro aprovado
Quando o KYC estiver aprovado, a chamada ao endpoint de emissão de contrato gerará o webhook de emissão de CCB, sem aplicação de bloqueios, e o callback retornarásuccess.
Retorno:
Onboarding não concluído
Quando o onboarding do cadastro ainda não estiver concluído, será retornado:Cadastro reprovado
Quando o cadastro tiver sido reprovado, o campomotivo retornará o detalhamento.
Documento com marcações de fraude: reprovado quando há marcações no DICT ou Rufra (Resolução Conjunta n6/BCB)
Quando a Emissão do Contrato Pode Ser Bloqueada
A geração da CCB poderá ser bloqueada quando a pessoa não possuir um resultado de KYC aprovado no momento da solicitação. Isso pode ocorrer em duas situações:- Análise em andamento: o processo de análise cadastral ainda não foi concluído.
- Cadastro reprovado: o resultado da análise cadastral foi desfavorável.
Observações
- A validação de onboarding somente é aplicada quando estiver habilitada para o produto.
- As mensagens apresentadas ao usuário são genéricas por razões regulatórias e de política interna.
- A aprovação do onboarding não substitui as demais validações executadas durante o processo de proposta.
Baixar Cartilha KYC para Parceiros (PDF)
Testes em Ambiente de Homologação
Para facilitar a homologação das integrações, o ambiente de homologação permite simular os possíveis resultados da análise KYC sem depender da conclusão do processo real. Para isso, basta enviar um CPF ou CNPJ válido cujo primeiro dígito determine o resultado esperado.Importante Esse comportamento está disponível apenas no ambiente de homologação com configuração de onboarding ativa e não se aplica ao ambiente de produção.
Resultados Simulados
Observações
- O documento informado deve possuir um CPF ou CNPJ válido.
- Apenas o primeiro dígito é utilizado para definir o resultado da simulação.

