Criar uma pessoa
Esse endpoint permite o cadastro de uma nova "pessoa", um participante do Originador.
Uma Pessoa (Person) na Plataforma é a representação de um Pessoa Física que realiza algum papel numa solicitação de Crédito.
Pessoas Físicas podem assumir os seguintes papéis numa solicitação:
-
Tomador
-
Anuente
-
Avalista
Adicionalmente, Pessoas podem ser vinculadas à empresas como Representantes Legais:
-
Representante Legal da Empresa Tomadora
-
Representante Legal do Credor/Financiador
-
Representante Legal do Originador
Parâmetros do Body
-
full_name(string, obrigatório): O nome completo da pessoa. -
taxpayer_id(string, obrigatório): O número do documento CPF para identificação da Pessoa. -
id_document(object, obrigatório): Objeto para detalhar o documento de identificação que está sendo enviado.-
issue_date(string, obrigatório): Data de emissão do documento. -
issuer(string, obrigatório): Orgão responsável pela emissão do documento. -
number(string, obrigatório): Número do documento. -
type(string, obrigatório): Tipo do documento. Valores aceitos: CNH, PASSPORT, RG, RNE.
-
-
sex(string): Gênero da pessoa, referente as características anatômicas. Valores aceitos: FEMALE, MALE, OTHER. -
nationality(string): A nacionalidade da pessoa cadastrada. -
birth_date(string): Data de nascimento no formato "AAAA-MM-DD". -
occupation(string): Cargo ou principal ocupação de trabalho. -
marital_status(string): Estado cívil no âmbito legal. Valores aceitos: DIVORCED, MARRIED, OTHER, SEPARATED, SINGLE, WIDOWED -
marital_property_system(string): O tipo de comunhão de bens adotado para o casamento. Valores aceitos: FINAL_COMMUNION, FULL_COMMUNION, NO_COMMUNION, PARTIAL_COMMUNION -
pep(boolean, obrigatório): Campo para indica se a pessoa é politicamente exposta. -
email_address(string): Endereço de e-mail para contato com a pessoa cadastrada. -
phone(object): Objeto contendo os dados do telefone de contato.-
country_code(string): Código do país. -
area_code(string): Código de área. -
number(string): Número do telefone.
-
-
address(object): Objeto contendo detalhes do endereço de cadastro.-
street_number(string): Número do endereço informado. -
street_name(string): Nome da rua. -
postal_code(string): Código de CEP para o endereço. -
district(string): Campo para informar o bairro. -
city(string): Nome da cidade. -
state_code(string): Código da UF para o estado do endereço. -
country_code(string): Código do país.
-
-
external_bank_account(object): Objeto contendo os dados bancários para depósito.-
bank_code(string): Código do banco. -
bank_account(string): Número da conta -
bank_account_digit(string): Dígito do número da conta. -
bank_branch(string): Número da agência. -
bank_account_type(string): Tipo da conta bancária. Valores aceitos: CACC, TRAN, SLRY, SVGS. -
ispb_code(string): Código da Instituição recebedora no Sistema de Pagamentos Instantâneo.
-
-
pix(object): Objeto contendo os dados de uma chave PIX.-
key(string): Chave PIX. -
key_type(string): Tipo da chave PIX. Valores aceitos: ALEATORY_KEY, EMAIL, PHONE_NUMBER, TAXPAYER_ID
-
Resposta
A resposta da requisição será um JSON representando o retorno obtido para os campos enviados.
Em caso de sucesso será retornado um status_code "200-OK". Em caso de falha será retornado um código 40x com a mensagem indicativa do erro.