Este endpoint permite atualizar os dados cadastrais de uma Pessoa associada a um Originador, facilitando a manutenção e correção de informações pessoais, profissionais, de contato e bancárias.
A operação é exclusivamente de atualização e não cria novos registros.
Apenas os campos informados no corpo da requisição serão atualizados; campos não enviados permanecerão inalterados.
Após a atualização, o endpoint retorna o objeto completo da Pessoa, contendo:
-
Dados pessoais e de identificação
-
Informações profissionais
-
Endereço
-
Telefone
-
Dados bancários externos
-
Chave PIX
-
Dados de cônjuge (quando aplicável)
-
Informações do Originador vinculado
-
Metadados de auditoria
Método HTTP
PUT
URL
https://sandbox.platform.flowfinance.com.br/banking/originator/persons/{person_id}
Path Parameters
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| person_id | string (UUID) | Sim | Identificador único da Pessoa que terá os dados atualizados |
Query Parameters
Este endpoint não possui parâmetros de query.
Headers
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| Authorization | string | Sim | Token de autenticação no formato Bearer {access_token} |
| Content-Type | string | Sim | Deve ser informado como application/json |
Body Parameters
Os campos enviados no corpo da requisição serão utilizados para atualização do cadastro.
Campos não informados permanecem inalterados.
Dados Pessoais
| Campo | Tipo | Descrição |
|---|---|---|
| full_name | string | Nome completo |
| taxpayer_id | string | CPF ou CNPJ |
| nationality | string | Nacionalidade |
| birth_date | string (YYYY-MM-DD) | Data de nascimento |
| birthplace | string | Naturalidade |
| sex | string | Gênero biológico (FEMALE, MALE, OTHER) |
| occupation | string | Cargo ou ocupação |
| pep | boolean | Indica se a pessoa é politicamente exposta |
| monthly_income | float | Renda mensal estimada |
| education_level | string | Nível de escolaridade |
| mothers_name | string | Nome da mãe |
Estado Civil
| Campo | Tipo | Descrição |
|---|---|---|
| marital_status | string | Estado civil (DIVORCED, MARRIED, OTHER, SEPARATED, SINGLE, WIDOWED) |
| marital_property_system | string | Regime de bens (FINAL_COMMUNION, FULL_COMMUNION, NO_COMMUNION, PARTIAL_COMMUNION) |
| spouse_full_name | string | Nome completo do cônjuge |
| spouse_taxpayer_id | string | CPF do cônjuge |
| spouse_date_of_birth | string (YYYY-MM-DD) | Data de nascimento do cônjuge |
Documento de Identificação (id_document)
Objeto contendo os dados do documento oficial da pessoa.
| Campo | Tipo | Descrição |
|---|---|---|
| id_document | object | Dados do documento |
| id_document.number | string | Número do documento |
| id_document.type | string | Tipo (CNH, PASSPORT, RG, RNE) |
| id_document.issuer | string | Órgão emissor |
| id_document.issue_date | string (YYYY-MM-DD) | Data de emissão |
Contato
| Campo | Tipo | Descrição |
|---|---|---|
| email_address | string |
Telefone (phone)
| Campo | Tipo | Descrição |
|---|---|---|
| country_code | string | Código do país |
| area_code | string | Código de área |
| number | string | Número do telefone |
Endereço (address)
| Campo | Tipo | Descrição |
|---|---|---|
| street_name | string | Logradouro |
| street_number | integer | Número |
| postal_code | string | CEP |
| district | string | Bairro |
| city | string | Cidade |
| state_code | string | UF |
| country_code | string | Código do país |
| extra_info | string | Complemento |
Conta Bancária Externa (external_bank_account)
| Campo | Tipo | Descrição |
|---|---|---|
| bank_code | string | Código do banco |
| bank_branch | string | Agência |
| bank_account | string | Conta |
| bank_account_digit | string | Dígito |
| bank_account_type | string | Tipo da conta |
| ispb_code | string | Código ISPB |
Chave PIX (pix)
| Campo | Tipo | Descrição |
|---|---|---|
| key | string | Chave PIX |
| key_type | string | Tipo (ALEATORY_KEY, EMAIL, PHONE_NUMBER, TAXPAYER_ID) |
Exemplo de Requisição
PUT /banking/originator/persons/{person_id}
Host: sandbox.platform.flowfinance.com.br
Authorization: Bearer {access_token}
Content-Type: application/json
Resposta de Sucesso
Status: 200 OK
Pessoa atualizada com sucesso. O retorno contém o objeto completo da Pessoa com os dados persistidos.
Exemplo de Resposta
{
"id": "fb6b3365-6efd-4ec9-b554-048bf616a43e",
"taxpayer_id": "47343076019",
"full_name": "Carlos Pereira",
...
}
Metadados da Resposta
| Campo | Tipo | Descrição |
|---|---|---|
| id | string (UUID) | Identificador único da pessoa |
| created_at | datetime (ISO 8601) | Data/hora de criação |
| updated_at | datetime (ISO 8601) | Data/hora da última atualização |
| version | integer | Versão do registro |
| custom_variables | object | Variáveis customizadas |
Códigos de Retorno
| Código HTTP | Descrição |
|---|---|
| 200 OK | Pessoa atualizada com sucesso |
| 401 Unauthorized | Token ausente ou inválido |
| 403 Forbidden | Acesso não autorizado |
| 500 Internal Server Error | Erro inesperado no servidor |