> ## Documentation Index
> Fetch the complete documentation index at: https://bmpdocs.moneyp.com.br/llms.txt
> Use this file to discover all available pages before exploring further.

# Processo de Onboarding KYC

> Visão funcional do processo de onboarding KYC no E-Consignado.

## 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

```mermaid theme={null}
flowchart TB
    A["<b>Cadastro do tomador</b><br/>Endpoint<br/>/trabalhador/cadastrar-vinculo"]
    B["<b>Emissão de Contrato</b><br/>Endpoint<br/>/contrato/oferta-ativa/gerar-contrato"]
    C["<b>Análise de KYC</b><br/>Coleta, Enriquecimento, Validação e Classificação de Risco Cadastral<br/><br/><b>Callback V001</b>"]
    D["<b>Cadastro aprovado</b>"]
    E["<b>Análise manual</b><br/><br/><b>Callback V001</b>"]
    F["<b>Cadastro reprovado</b><br/>Callback de erro: V0002, V0003 ou V0004"]
    G["<b>Retorno success</b><br/>Webhook de geração de CCB"]
    H["Obs.: documentos e informações adicionais podem ser solicitados, conforme Cartilha de KYC"]

    A --> B
    B --> C
    C --> D
    C --> E
    C --> F
    D --> G
    E -.- H

    classDef etapa fill:#ffffff,stroke:#1a1883,stroke-width:2px,color:#1a1883
    classDef decisao fill:#e6eafc,stroke:#1a1883,stroke-width:2px,color:#1a1883
    classDef positivo fill:#dff3ff,stroke:#33beff,stroke-width:2px,color:#1a1883
    classDef alerta fill:#1a1883,stroke:#1a1883,stroke-width:2px,color:#ffffff
    classDef nota fill:#ffffff,stroke:#919191,stroke-width:1px,stroke-dasharray:5 5,color:#444444

    class A,B etapa
    class C decisao
    class D,E,G positivo
    class F alerta
    class H nota

    linkStyle default stroke:#1a1883,stroke-width:2px
```

## Etapas

1. O cadastro é incluído por meio da API `/trabalhador/cadastrar-vinculo`.
2. O valor da proposta de crédito, e demais informações, são incluídos por meio da API `/contrato/oferta-ativa/gerar-contrato`.
3. 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.
4. O resultado da análise é recebido pelo nosso sistema.
5. Com o retorno de callback aprovado, o fluxo é liberado para a emissão de contrato.
6. 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:**

```json theme={null}
{
  "resultado": [
    {
      "documentoFederal": "12345678000199",
      "valido": true,
      "motivo": null
    }
  ]
}
```

### Onboarding não concluído

Quando o onboarding do cadastro ainda não estiver concluído, será retornado:

```json theme={null}
{
  "resultado": [
    {
      "documentoFederal": "12345678000199",
      "valido": true,
      "motivo": "Esta pessoa não possui onboarding concluído"
    }
  ]
}
```

### Cadastro reprovado

Quando o cadastro tiver sido reprovado, o campo `motivo` retornará o detalhamento.

**Documento com marcações de fraude:** reprovado quando há marcações no DICT ou Rufra (Resolução Conjunta n6/BCB)

```json theme={null}
{
  "resultado": [
    {
      "documentoFederal": "12345678000199",
      "valido": true,
      "motivo": "Documento com marcações de fraude no mercado"
    }
  ]
}
```

**Divergência entre dados informados e dados enriquecidos:** Quando houver divergência entre os dados fornecidos no cadastro e as informações enriquecidas pelos bureaus. Neste caso, nova requisição de cadastro e emissão do contrato deve ser realizado com os campos corrigidos.

```json theme={null}
{
  "resultado": [
    {
      "documentoFederal": "12345678000199",
      "valido": true,
      "motivo": "Os dados fornecidos são incompatíveis com os bureaus. Realize novo cadastro com dados corrigidos. Campos: XXXX, XXXXX"
    }
  ]
}
```

Os campos divergentes serão identificados na mensagem de retorno.

**Reprovação por Políticas Internas:** quando, para atendimento à Carta Circular 3978 e em respeito ao apetite de risco da BMP, o cadastro é reprovado.

```json theme={null}
{
  "resultado": [
    {
      "documentoFederal": "12345678000199",
      "valido": true,
      "motivo": "Esta pessoa foi reprovada por Políticas Internas, restritas à BMP por força regulatória"
    }
  ]
}
```

***

## 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.

Nessas situações, a tentativa de inclusão da proposta retornará erro HTTP 400, conforme o motivo correspondente.

Para identificar o resultado da análise e o motivo do bloqueio, consulte os retornos disponibilizados via callback.

***

## 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)](https://bmpdocs.moneyp.com.br/caas/kyc-cartilha-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

| Primeiro dígito do documento | Resultado simulado |
| - | - |
| 100 | Onboarding aprovado |
| 200 | Onboarding reprovado |
| 300 | Onboarding pendente |
| Qualquer outro | Nenhum resultado é gerado |

### 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.