v1

latestOpenAPI 3.0.12026-07-261451591021.8 KB
Onboarding PF

Cadastro dos dados cadastrais

Onboarding PF - Cadastro de dados da Validação Cadastral<br/>Permite que parceiros informem os dados cadastrais para validação da abertura de conta.<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>nome</td><td>Texto</td><td>Nome completo do cliente.</td><td>Sim</td></tr><tr><td>cpf</td><td>Texto</td><td>CPF do cliente (com ou sem máscara).</td><td>Sim</td></tr><tr><td>endereco</td><td>Texto</td><td>Endereço de residência.</td><td>Sim</td></tr><tr><td>numero</td><td>Texto</td><td>Número da residência.</td><td>Sim</td></tr><tr><td>bairro</td><td>Texto</td><td>Bairro da residência.</td><td>Sim</td></tr><tr><td>cidade</td><td>Texto</td><td>Cidade de residência.</td><td>Sim</td></tr><tr><td>cep</td><td>Texto</td><td>CEP da residência.</td><td>Sim</td></tr><tr><td>uf</td><td>Texto</td><td>Unidade Federativa (UF) com 2 letras.</td><td>Sim</td></tr><tr><td>datanascimento</td><td>Data</td><td>Data de nascimento no formato YYYY-MM-DD.</td><td>Sim</td></tr><tr><td>naturalidade</td><td>Texto</td><td>Naturalidade do cliente.</td><td>Sim</td></tr><tr><td>numeroident</td><td>Texto</td><td>Número do documento de identidade.</td><td>Sim</td></tr><tr><td>dataident</td><td>Data</td><td>Data de emissão da identidade (YYYY-MM-DD).</td><td>Sim</td></tr><tr><td>uforgaoident</td><td>Texto</td><td>UF emissor do documento.</td><td>Sim</td></tr><tr><td>email</td><td>Texto</td><td>E-mail válido do cliente.</td><td>Sim</td></tr><tr><td>ddd</td><td>Texto</td><td>DDD do telefone (2 dígitos).</td><td>Sim</td></tr><tr><td>telefone</td><td>Texto</td><td>Telefone de contato (até 10 caracteres, sem ddd).</td><td>Sim</td></tr><tr><td>cargo</td><td>Texto</td><td>Cargo ocupado (obrigatório se PPE = S).</td><td>Condicional</td></tr><tr><td>periodo</td><td>Texto</td><td>Período do cargo (obrigatório se PPE = S).</td><td>Condicional</td></tr><tr><td>observação</td><td>Texto</td><td>Observação do cargo (obrigatório se PPE = S).</td><td>Condicional</td></tr><tr><td>tipoident</td><td>Texto</td><td>Tipo do documento.</td><td>Sim</td></tr><tr><td>orgaoident</td><td>Texto</td><td>Órgão emissor.</td><td>Sim</td></tr><tr><td>nacionalidade</td><td>Texto</td><td>“N” para nacional, “S” para estrangeiro.</td><td>Sim</td></tr><tr><td>sexo</td><td>Texto</td><td>“M” para masculino, “F” para feminino.</td><td>Sim</td></tr><tr><td>foto</td><td>Texto</td><td>Imagem em base64 no padrão data:image/... (máx. 8000 caracteres).</td><td>Não</td></tr><tr><td>ppe</td><td>Texto</td><td>“S” se PPE, “N” caso contrário.</td><td>Não</td></tr><tr><td>complemento</td><td>Texto</td><td>Complemento do endereço (ex: apto, bloco).</td><td>Não</td></tr><tr><td>nomemae</td><td>Texto</td><td>Nome da mãe do cliente.</td><td>Não</td></tr><tr><td>nomepai</td><td>Texto</td><td>Nome do pai do cliente.</td><td>Não</td></tr><tr><td>renda</td><td>Float</td><td>Renda anual estimada.</td><td>Não</td></tr><tr><td>jwt_documento</td><td>Texto</td><td>Token jwt do documento.</td><td>Sim</td></tr><tr><td>jwt_liveness</td><td>Texto</td><td>Token jwt da prova de vida.</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/validacao-cadastral

Headers

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

Client ID enviado no Header

Request body

nomestring
cpfstring
enderecostring
numerostring
bairrostring
cidadestring
cepstring
ufstring
datanascimentostring date
naturalidadestring
numeroidentstring
dataidentstring date
uforgaoidentstring
emailstring email
dddstring
telefonestring
cargostring
periodostring
observaçãostring
tipoidentstring
orgaoidentstring
nacionalidadestring
sexostring
fotostring
ppestring
complementostring
nomemaestring
nomepaistring
rendanumber float
jwt_documentostring
jwt_livenessstring

Example request

{
  "nome": "João da Silva",
  "cpf": "12345678900",
  "endereco": "Rua das Flores",
  "numero": "123",
  "bairro": "Centro",
  "cidade": "São Paulo",
  "cep": "01001000",
  "uf": "SP",
  "datanascimento": "1990-01-01",
  "naturalidade": "Curitibana",
  "numeroident": "123456789",
  "dataident": "2010-05-10",
  "uforgaoident": "SP",
  "email": "joao@email.com",
  "ddd": "11",
  "telefone": "912345678",
  "cargo": "Diretor Executivo",
  "periodo": "2018-2024",
  "observação": "Exerce cargo político atualmente",
  "tipoident": "CNH, RG ou OAB",
  "orgaoident": "DETRAN",
  "nacionalidade": "N",
  "sexo": "M",
  "foto": "data:image/jpeg;base64,/9j/4AAQSkZJRgABAQEASABIAAD...",
  "ppe": "S",
  "complemento": "Apto 201",
  "nomemae": "Maria da Silva",
  "nomepai": "José da Silva",
  "jwt_documento": "eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkFydHVyIFNhbXBhaW8iLCJpYXQiOjE1MTYyMzkwMjJ9...",
  "jwt_liveness": "eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkFydHVyIFNhbXBhaW8iLCJpYXQiOjE1MTYyMzkwMjJ9..."
}

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
}