Sign in

v1

latestOpenAPI 3.0.12026-07-261451591021.8 KB
Onboarding PF

Cadastro de conta adicional

Onboarding PF - Cadastro de conta adicional<br/>Permite que parceiros informem os dados cadastrais para validação da abertura de uma conta adicional.<br/><br/>Requisição<br/><table><thead><tr><th>Campo</th><th>Tipo</th><th>Descrição</th><th>Obrigatoriedade</th></tr></thead><tbody><tr><td>cpf</td><td>Texto</td><td>CPF do cliente (com ou sem máscara).</td><td>Sim</td></tr><tr><td>tipoident</td><td>Texto</td><td>Tipo do documento (CPF).</td><td>Sim</td></tr></tbody></table><br/><br/>Resposta - Sucesso (200)<br/><table><thead><tr><th>Campo</th><th>Tipo</th><th>Descrição</th></tr></thead><tbody><tr><td>message</td><td>Texto</td><td>Mensagem de confirmação do cadastro</td></tr><tr><td>data.contaUuid</td><td>Texto</td><td>Uuid da conta</td></tr><tr><td>data.nomeCliente</td><td>Texto</td><td>Nome do conta</td></tr><tr><td>data.numeroConta</td><td>Texto</td><td>Numero da conta</td></tr><tr><td>data.statusConta</td><td>Texto</td><td>Status da conta</td></tr><tr><td>data.statusContaEnum</td><td>Texto</td><td>Status ENUM da conta</td></tr><tr><td>statusCode</td><td>Inteiro</td><td>Código HTTP da resposta</td></tr><tr><td>status</td><td>Booleano</td><td>Status lógico da operação</td></tr></tbody></table>

post/api/v1/onboarding-pf/conta-adicional

Headers

client-idstring uuid required
Example:xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx

Client ID enviado no Header

Request body

cpfstring
tipoidentstring

Example request

{
  "cpf": "12345678900",
  "tipoident": "CPF"
}

Response

Dados recebidos com sucesso.

messagestring
errorsstring
statusCodeinteger
statusboolean

Example response

{
  "message": "Dados recebidos com sucesso.",
  "data": {
    "contaUuid": "8df1498b-c443-4573-9bd1-87fbf7215671",
    "nomeCliente": "João da Silva",
    "statusConta": "Aguardando análise KYC",
    "statusContaEnum": "awaiting_kyc_analysis"
  },
  "statusCode": 200,
  "status": true
}