put http://{{auth_server_host}}/banking/originator/persons/
Esse endpoint permite uma atualização dos dados cadastrais de uma Pessoa.
Parâmetros da URL
person_id: ID (uuid) da Pessoa cadastrada que terá os dados atualizados.
Parâmetros da Requisição
full_name(string): O nome completo da pessoa.
taxpayer_id(string): O número de documento para identificação, pode ser um CPF ou CNPJ.
id_document(object): Objeto para detalhar o documento de identificação que está sendo enviado.issue_date(string): Data de emissão do documento.
issuer(string): Orgão responsável pela emissão do documento.
number(string): Número do documento.
type(string): 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): 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(int): 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.
ispb_code(string): Código ISPB relacionado ao banco da conta informada.
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
spouse_full_name(string): Nome do cônjuge.
originator(object): Objeto contendo os dados do Originador.id(string/UUID): ID de cadastro do Originador.
legal_name(string): Nome/Razão Social do Originador.
created_at(datetime): Data/Hora do cadastro no formato ISO 8601. Ex.: 2024-06-05T10:34:08.957Z.
spouse_taxpayer_id(string): Documento de identificação do cônjuge.
spouse_date_of_birth(string): Data de nascimento do cônjuge.
birthplace(string): Naturalidade, local de nascimento.
monthly_income(float): Renda mensal estimada.
employer(string): Area de atuação.
id: The unique identifier of the person.
taxpayer_id: The taxpayer ID of the person.
nationality: The nationality of the person.
pep: A boolean indicating whether the person is a politically exposed person.
full_name: The full name of the person.
phone: An object containing the country code, area code, number, and formatted number of the person's phone.
occupation: The occupation of the person.
birth_date: The birth date of the person.
marital_status: The marital status of the person.
email_address: The email address of the person.
mothers_name: The name of the person's mother.
marital_property_system: The marital property system of the person.
id_document: An object containing the number, issuer, issue date, and type of the person's ID document.
sex: The gender of the person.
address: An object containing the street name, street number, postal code, district, city, state code, country code, and extra information of the person's address.
pix: An object containing the key and key type of the person's PIX (Brazilian instant payment system) information.
external_bank_account: An object containing the bank code, bank account, bank account digit, bank branch, bank account type, and ISPB code of the person's external bank account.
custom_variables: An object containing custom variables of the person.
spouse_full_name: The full name of the person's spouse.
originator: An object containing the ID and legal name of the person's originator.
employer: The employer of the person.
created_at: The date and time when the person's record was created.
version: The version of the person's record.
spouse_taxpayer_id: The taxpayer ID of the person's spouse.
spouse_date_of_birth: The date of birth of the person's spouse.
birthplace: The birthplace of the person.
monthly_income: The monthly income of the person.
Parâmetros da URL
person_id(string) : Identificador do cadastro da pessoa a ser consulta.
Resposta
Se a requisição for aceita e processada com sucesso, a resposta inclui um código 200 e um objeto Json contendo os detalhes dos dados da Pessoa atualizada no seguinte formato:
Exemplo:
{
"id": "",
"taxpayer_id": "",
"nationality": "",
"pep": true,
"full_name": "",
"phone": {
"country_code": "",
"area_code": "",
"number": "",
"formatted_number": ""
},
"occupation": "",
"birth_date": "",
"marital_status": "",
"email_address": "",
"mothers_name": "",
"marital_property_system": "",
"id_document": {
"number": "",
"issuer": "",
"issue_date": "",
"type": ""
},
"sex": "",
"address": {
"street_name": "",
"street_number": 0,
"postal_code": "",
"district": "",
"city": "",
"state_code": "",
"country_code": "",
"extra_info": null
},
"pix": {
"key": "",
"key_type": ""
},
"external_bank_account": {
"bank_code": "",
"bank_account": "",
"bank_account_digit": "",
"bank_branch": "",
"bank_account_type": "",
"ispb_code": 0
},
"custom_variables": {},
"spouse_full_name": "",
"originator": {
"id": "",
"legal_name": ""
},
"employer": "",
"created_at": "",
"version": 0,
"spouse_taxpayer_id": 0,
"spouse_date_of_birth": "",
"birthplace": "",
"monthly_income": 0
}