v1
latestOpenAPI 3.0.12026-07-261451591021.8 KBCadastro 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 (estrutura aninhada)<br/><table><thead><tr><th>Campo</th><th>Tipo</th><th>Descrição</th><th>Obrigatoriedade</th></tr></thead><tbody><tr><td>dadosPessoais</td><td>Objeto</td><td>Grupo de dados pessoais</td><td>Sim</td></tr><tr><td>dadosPessoais.nome</td><td>Texto</td><td>Nome completo (máx. 35)</td><td>Sim</td></tr><tr><td>dadosPessoais.email</td><td>Texto (email)</td><td>E-mail válido (máx. 50)</td><td>Sim</td></tr><tr><td>dadosPessoais.cpf</td><td>Texto</td><td>CPF (com ou sem máscara, máx. 14)</td><td>Sim</td></tr><tr><td>dadosPessoais.nacionalidade</td><td>Texto</td><td>“N” nacional, “S” estrangeiro</td><td>Sim</td></tr><tr><td>dadosPessoais.sexo</td><td>Texto</td><td>“M” ou “F”</td><td>Sim</td></tr><tr><td>dadosPessoais.renda</td><td>Numérico</td><td>Renda (opcional)</td><td>Não</td></tr><tr><td>dadosPessoais.datanascimento</td><td>Data</td><td>Formato YYYY-MM-DD</td><td>Sim</td></tr><tr><td>dadosPessoais.naturalidade</td><td>Texto</td><td>Naturalidade (máx. 100)</td><td>Sim</td></tr><tr><td>dadosPessoais.nomemae</td><td>Texto</td><td>Nome da mãe (máx. 100)</td><td>Não</td></tr><tr><td>dadosPessoais.nomepai</td><td>Texto</td><td>Nome do pai (máx. 100)</td><td>Não</td></tr><tr><td>endereco</td><td>Objeto</td><td>Grupo de endereço</td><td>Sim</td></tr><tr><td>endereco.codigo_postal</td><td>Texto</td><td>CEP (máx. 9)</td><td>Sim</td></tr><tr><td>endereco.rua</td><td>Texto</td><td>Logradouro (máx. 100)</td><td>Sim</td></tr><tr><td>endereco.numero</td><td>Texto</td><td>Número (máx. 10)</td><td>Sim</td></tr><tr><td>endereco.complemento</td><td>Texto</td><td>Complemento (máx. 40)</td><td>Não</td></tr><tr><td>endereco.bairro</td><td>Texto</td><td>Bairro (máx. 20)</td><td>Sim</td></tr><tr><td>endereco.cidade</td><td>Texto</td><td>Cidade (máx. 25)</td><td>Sim</td></tr><tr><td>endereco.uf</td><td>Texto</td><td>UF (2 letras)</td><td>Sim</td></tr><tr><td>telefone</td><td>Objeto</td><td>Grupo de telefone</td><td>Sim</td></tr><tr><td>telefone.ddd</td><td>Texto</td><td>DDD (2 dígitos)</td><td>Sim</td></tr><tr><td>telefone.numero</td><td>Texto</td><td>Número (máx. 10)</td><td>Sim</td></tr><tr><td>rg</td><td>Objeto</td><td>Grupo de documento</td><td>Sim</td></tr><tr><td>rg.numero</td><td>Texto</td><td>Número do documento (máx. 15)</td><td>Sim</td></tr><tr><td>rg.dataExp</td><td>Data</td><td>Data de expedição (YYYY-MM-DD)</td><td>Sim</td></tr><tr><td>rg.uforgaoExp</td><td>Texto</td><td>UF do órgão expedidor (2)</td><td>Sim</td></tr><tr><td>rg.tipoident</td><td>Texto</td><td>CNH, RG ou OAB</td><td>Sim</td></tr><tr><td>rg.orgaoident</td><td>Texto</td><td>Órgão emissor</td><td>Sim</td></tr><tr><td>politicamenteExposto</td><td>Objeto</td><td>Grupo de PEP</td><td>Não</td></tr><tr><td>politicamenteExposto.ppe</td><td>Texto</td><td>“S” ou “N”</td><td>Não</td></tr><tr><td>politicamenteExposto.cargo</td><td>Texto</td><td>Cargo (obrigatório se ppe=“S”, máx. 100)</td><td>Condicional</td></tr><tr><td>politicamenteExposto.periodo</td><td>Texto</td><td>Período (máx. 100)</td><td>Não</td></tr><tr><td>politicamenteExposto.observação</td><td>Texto</td><td>Observação (máx. 100)</td><td>Não</td></tr><tr><td>caf</td><td>Objeto</td><td>Grupo de tokens CAF</td><td>Sim</td></tr><tr><td>caf.jwt_documento</td><td>Texto</td><td>JWT do documento</td><td>Sim</td></tr><tr><td>caf.jwt_liveness</td><td>Texto</td><td>JWT de liveness</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 cliente</td></tr><tr><td>data.numeroConta</td><td>Texto</td><td>Número 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>
Headers
Client ID enviado no Header
Request body
Example request
{
"dadosPessoais": {
"nome": "João da Silva",
"email": "joao@email.com",
"cpf": "12345678900",
"nacionalidade": "N/S",
"sexo": "M/F",
"renda": 50000,
"datanascimento": "1990-01-01",
"naturalidade": "Curitibana",
"nomemae": "Maria da Silva",
"nomepai": "José da Silva"
},
"endereco": {
"codigo_postal": "01001000",
"rua": "Rua das Flores",
"numero": "123",
"complemento": "Apto 201",
"bairro": "Centro",
"cidade": "São Paulo",
"uf": "SP"
},
"telefone": {
"ddd": "11",
"numero": "912345678"
},
"rg": {
"numero": "123456789",
"dataExp": "2010-05-10",
"uforgaoExp": "SP",
"tipoident": "CNH/RG/OAB",
"orgaoident": "SESP"
},
"politicamenteExposto": {
"ppe": "S/N",
"cargo": "Diretor Executivo",
"periodo": "2018-2024",
"observação": "Exerce cargo político atualmente"
},
"caf": {
"jwt_documento": "eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkFydHVyIFNhbXBhaW8iLCJpYXQiOjE1MTYyMzkwMjJ9...",
"jwt_liveness": "eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkFydHVyIFNhbXBhaW8iLCJpYXQiOjE1MTYyMzkwMjJ9..."
}
}Response
Dados recebidos com sucesso.
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
}