Responsável pela criação de novas contas e pelo recadastramento (atualização cadastral) de clientes do tipo Pessoa Física (PF).
| Time | Status | User Agent | |
|---|---|---|---|
Retrieving recent requests… | |||
Seu comportamento é idempotente, o que significa que o mesmo payload pode ser enviado múltiplas vezes de forma segura, atualizando ou criando o perfil de acordo com a necessidade.
O payload contempla dados abrangentes do cliente, passando por identificação, endereço, dados financeiros, profissionais, informações bancárias e termo de aceite (Suitability).
- Estrutura da Requisição (Request Body) O endpoint espera um payload JSON ou Form-Data contendo o objeto de entrada (ClientRegistrationV2Input).
2.1 client_identification (Obrigatório) Dados primários para identificação do cliente.
name (string): Nome completo do cliente (Max: 200). cpf (string): CPF do cliente (11 dígitos). email (string): Endereço de e-mail válido. birth_date (date): Data de nascimento (YYYY-MM-DD). mobile_phone (string, opcional): Telefone celular (11 dígitos). 2.2 personal_data (Obrigatório) Informações pessoais e filiação.
nationality_id (integer): ID da nacionalidade. gender (string): Gênero (M para masculino, F para feminino). marital_status_id (integer): ID do estado civil. mother_name (string): Nome da mãe. father_name (string, opcional): Nome do pai. birth_country (string): Sigla do país de nascimento (2 caracteres). birth_city_ibge (string, opcional): Código IBGE da cidade natal (7 dígitos). spouse (object, opcional): Objeto contendo name e cpf do cônjuge. IMPORTANT
Regras de Validação (Personal Data):
Se nationality_id == 1 (Brasileiro Nato), o envio do birth_city_ibge é obrigatório. O código IBGE informado deve existir no banco de dados. Se marital_status_id for 2 (Casado) ou 6 (União Estável), o objeto spouse é obrigatório. 2.3 identification_document (Opcional/Anulável) Dados do documento de identificação (RG, CNH, RNE, etc.).
type_id (integer): ID do tipo do documento. number (string): Número do documento. issuing_authority_id (integer): ID do órgão emissor. issuing_uf (string): Estado emissor (UF, 2 caracteres). issue_date (date): Data de emissão. expiration_date (date, opcional): Data de validade. cnh_security_code (string, opcional): Código de segurança da CNH. NOTE
Regras de Validação (Documento):
Se o documento for do tipo CNH, a chave cnh_security_code é obrigatória. Para tipos de documento que exigem estado emissor, o envio da issuing_uf é estritamente validado. 2.4 residential_address (Obrigatório) Endereço residencial.
zip_code (string): CEP (8 dígitos). street (string): Nome da rua/logradouro. number (string): Número do endereço. neighborhood (string): Bairro. city_ibge (string): Código IBGE da cidade onde reside. complement (string, opcional): Complemento. 2.5 professional_data (Obrigatório) Informações profissionais.
occupation_id (integer): ID da ocupação/profissão atual. employment_status (string): Situação trabalhista (ex: "employed", "unemployed"). company_name (string, opcional): Nome da empresa. employer_cnpj (string, opcional): CNPJ da empresa. Se employment_status for "employed" (empregado), o fornecimento do company_name passa a ser obrigatório.
2.6 financial_data (Obrigatório) Capacidade financeira e patrimônio.
total_financial_investments (decimal, opcional): Volume financeiro total investido. gross_annual_income (decimal, opcional): Renda bruta anual. total_other_assets_value (decimal, opcional): Valor de outros bens (imóveis, veículos). 2.7 bank_accounts (Array, Opcional) Lista de contas bancárias para movimentação de fundos.
bank_code (string): Código do banco (Febraban). branch (string): Agência (sem o dígito). account_number (string): Número da conta. account_digit (string): Dígito da conta. account_type (string): Tipo de conta (CC para Corrente, CP para Poupança). is_joint_account (boolean): Indica se é conta conjunta. is_second_holder_main (boolean): Indica se o segundo titular é o principal. co_holder_cpf (string, opcional): CPF do cotitular.
Se is_joint_account for true, o preenchimento de co_holder_cpf é obrigatório.
2.8 suitability Questionário de perfil de investidor.
form_version_id (integer): ID da versão do formulário de suitability preenchido. answers (array de objetos): Lista com as respostas selecionadas (contendo o choice_id). 2.9 declarations_and_terms (Obrigatório) Declarações legais e termos de aceite.
politically_exposed_person (boolean): Pessoa Politicamente Exposta (PEP). us_person (boolean): US Person (Cidadão/residente fiscal dos EUA). qualified_investor (boolean): Investidor Qualificado. accept_suitability_terms (boolean): Aceite do termo do questionário Suitability. accept_registration_terms (boolean): Aceite do termo de cadastro.
