Campos da Pessoa
Estes campos são utilizados quando você precisa Criar, Editar ou Consultar uma Pessoa.
| Nome do campo | Caminho | Descrição |
|---|---|---|
| Nome completo | full_name | Nome da Pessoa, deve ser compatível com a documentação aplicável. Não deve ser usado para comunicação máquina-a-máquina. |
| CPF | taxpayer_id | CPF da Pessoa. |
| Data de Nascimento | birth_date | Data de Nascimento |
| Variáveis personalizadas | custom_variables | Valores de variáveis personalizadas, no formato chave-valor. |
email_address | Endereço de email | |
| Empregador | employer.id | Identificador do empregador da Pessoa, útil para operações de consignado, onde o devedor das operações de crédito é o empregador. |
| Dados bancários | external_bank_account | Dados bancários para depósito utilizando Pix Manual. bank_account=Conta, bank_account_digit=Dígito Conta, bank_branch=Agência, ispb_code=Código da Instituição recebedora no Sistema de Pagamentos Instantâneo, bank_account_type=Tipo de Conta, um de: CACC, TRAN, SLRY, SVGS |
| Identificador | id | Identificador único da Pessoa. Indicado para comunicação máquina-a-máquina. |
| Documento de Identificação | id_document | Registro de Documento de Identificação. Documentos possíveis: CNH, PASSPORT, RG, RNE. Onde aplicável, é necessário informar, além de type e number, também issuer e issue_date. |
| Estado civil | marital_status | Um de: DIVORCED, MARRIED, OTHER, SEPARATED, SINGLE, WIDOWED |
| Comunhão de bens | marital_property_system | Um de: FINAL_COMMUNION, FULL_COMMUNION, NO_COMMUNION, PARTIAL_COMMUNION |
| Pessoa Politicamente Exposta? | pep | Determina se esta pessoa é politicamente exposta e precisa de tratamento especial nas plataformas de dados, KYC, AML e Prevenção a Corrupção. |
| Nome da mãe | mothers_name | Nome da mãe |
| Nacionalidade | nationality | |
| Ocupação | occupation | Ocupação, emprego ou ofício. |
| Originador | originator.id | Indica o originador que realizou o cadastro desta pessoa |
| Telefone | phone.{area_code,country_code,number} | Número para contato telefônico, incluindo DDD e código do país. |
| Chave Pix | pix.key | Valor da chave Pix |
| Tipo Chave Pix | pix.key_type | Tipo de Chave Pix: ALEATORY_KEY, EMAIL, PHONE_NUMBER, TAXPAYER_ID |
| Sexo | sex | Sexo da Pessoa: FEMALE, MALE, OTHER |
| Nome completo Cônjuge | spouse_full_name | Nome completo Cônjuge |
Updated 12 months ago