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

# Consulta de Onboarding KYC

> Consulte o resultado mais recente do processo de KYC de uma pessoa ou empresa.

# Consulta de Onboarding KYC

Esta API consulta o onboarding KYC mais recente de uma pessoa física ou jurídica a partir do CPF ou CNPJ.

## Endpoint

```http theme={null}
POST https://{urlbase}/Pessoa/ConsultarOnboardingKYC
```

A requisição deve utilizar o token Bearer fornecido para sua integração.

```http theme={null}
Authorization: Bearer {token}
Content-Type: application/json
```

## Envio

O CPF ou CNPJ pode ser enviado com ou sem pontuação.

```json theme={null}
{
  "dto": {
    "documentoFederal": "123.456.789-01"
  }
}
```

## Retorno

```json theme={null}
{
  "msg": "",
  "hasError": false,
  "messages": [],
  "documentoFederal": "12345678901",
  "nome": "Nome da pessoa",
  "dtInclusao": "2026-08-05T10:30:00",
  "valido": true,
  "motivo": "",
  "dtExecucaoKYC": "2026-08-05T10:35:00"
}
```

| Campo              | Descrição                                                                                               |
| ------------------ | ------------------------------------------------------------------------------------------------------- |
| `documentoFederal` | CPF ou CNPJ consultado.                                                                                 |
| `nome`             | Nome da pessoa ou empresa.                                                                              |
| `dtInclusao`       | Data em que o onboarding foi solicitado.                                                                |
| `valido`           | `true` para KYC aprovado e `false` para não aprovado ou ainda pendente.                                 |
| `motivo`           | Motivo da não aprovação ou mensagem informando que o KYC está pendente. Para aprovações, retorna vazio. |
| `dtExecucaoKYC`    | Data em que o resultado do KYC foi recebido.                                                            |

## KYC aguardando retorno

Quando `dtExecucaoKYC` for `null`, ainda não houve retorno da solicitação de KYC. Nesse caso, o resultado permanece pendente e a API retorna:

```json theme={null}
{
  "valido": false,
  "motivo": "O onboarding foi encontrado, mas o processo de KYC ainda não foi concluído. Aguarde a finalização.",
  "dtExecucaoKYC": null
}
```

Recomendamos realizar uma nova consulta posteriormente.

## Possíveis erros

| Código  | Situação                     | Mensagem                                                  |
| ------- | ---------------------------- | --------------------------------------------------------- |
| `V0001` | Documento não informado      | `Documento federal deve ser informado.`                   |
| `V0002` | CPF ou CNPJ inválido         | `Documento federal inválido.`                             |
| `V0003` | Onboarding inexistente       | `Onboarding para o documento federal não foi encontrado.` |
| —       | Token ausente ou inválido    | `Não autorizado.`                                         |
| —       | Indisponibilidade momentânea | `Não foi possível consultar o onboarding KYC.`            |