Consulta de pessoas por ID

get

https://sandbox.platform.flowfinance.com.br/banking/originator/persons/{person_id}

Este endpoint permite recuperar todas as informações da Pessoa, incluindo:

Dados pessoais e cadastrais
Documentos de identificação
Endereço
Dados bancários
Chave PIX
Vínculo com originador e empregador
Informações adicionais de auditoria e versionamento

⚠️ Observação

Esta operação é exclusivamente de consulta e não altera o estado do cadastro da Pessoa na plataforma.

Método HTTP

GET

URL

https://sandbox.platform.flowfinance.com.br/banking/originator/persons/{person_id}

Autenticação

Este endpoint requer autenticação via Bearer Token.

Authorization: Bearer {token}

Headers

Nome	Tipo	Obrigatório	Descrição
Authorization	string	Sim	Token de autenticação no formato `Bearer {token}`
Content-Type	string	Sim	Deve ser informado como `application/json`

Path Parameters

Nome	Tipo	Obrigatório	Descrição
person_id	string (UUID v4)	Sim	Identificador único da Pessoa previamente cadastrada na plataforma

Query Parameters

Este endpoint não possui parâmetros de query.

Body Parameters

Este endpoint não possui corpo de requisição, pois se trata de uma operação de consulta (GET).

Exemplo de Requisição

GET /banking/originator/persons/779ec8f6-8bf9-421d-90bc-863dedad5459
Host: sandbox.platform.flowfinance.com.br
Authorization: Bearer {token}
Content-Type: application/json

Resposta de Sucesso

200 OK

Retorna os dados completos da Pessoa Física consultada.

Exemplo de Resposta

{
  "id": "779ec8f6-8bf9-421d-90bc-863dedad5459",
  "external_id": null,
  "taxpayer_id": "12345678909",
  "nationality": "Brasileiro",
  "pep": false,
  "full_name": "Carlos Eduardo Pereira",
  "phone": {
    "country_code": "55",
    "area_code": "11",
    "number": "987654321",
    "formatted_number": "+5511987654321"
  },
  "occupation": "Analista de Sistemas",
  "birth_date": "1990-08-15",
  "marital_status": "MARRIED",
  "email_address": "[email protected]",
  "mothers_name": "Ana Lúcia Pereira",
  "marital_property_system": "PARTIAL_COMMUNION",
  "id_document": {
    "number": "45.678.912-3",
    "issuer": "SSP/SP",
    "issue_date": "2015-03-20",
    "type": "RG"
  },
  "sex": "MALE",
  "address": {
    "street_name": "Avenida Presidente Vargas",
    "street_number": 300,
    "postal_code": "01010000",
    "district": "Centro",
    "city": "São Paulo",
    "state_code": "SP",
    "country_code": "BRA",
    "extra_info": "Apartamento 42 – Bloco B"
  },
  "pix": {
    "key": "12345678909",
    "key_type": "TAXPAYER_ID"
  },
  "external_bank_account": {
    "bank_code": "001",
    "bank_account": "56789",
    "bank_account_digit": "0",
    "bank_branch": "1234",
    "bank_account_type": "CACC",
    "ispb_code": "00000000"
  },
  "custom_variables": {},
  "spouse_full_name": "Mariana Alves Pereira",
  "spouse_taxpayer_id": "98765432100",
  "spouse_date_of_birth": "1992-11-22",
  "originator": {
    "id": "b60dbf42-fd93-458a-a9b5-93342add3743",
    "legal_name": "portal teste em sandbox"
  },
  "employer": {
    "id": "008e1751-4d6c-438f-a928-c03ad48c30aa"
  },
  "created_at": "2026-01-26T17:32:08.482251Z",
  "updated_at": "2026-01-26T17:48:55.378463Z",
  "version": 2,
  "birthplace": "São Paulo",
  "monthly_income": 5500,
  "income_range": null,
  "has_scr_evidence": false,
  "scr_evidence_provider": null,
  "scr_evidence_type": null,
  "education_level": "HIGHER_COMPLETE"
}

Descrição dos Campos

Dados Gerais

Campo	Tipo	Descrição
id	string (UUID)	Identificador único da pessoa
full_name	string	Nome completo
taxpayer_id	string	CPF da pessoa
nationality	string	Nacionalidade
birth_date	string (YYYY-MM-DD)	Data de nascimento
birthplace	string	Naturalidade
sex	string	Gênero biológico (`FEMALE`, `MALE`, `OTHER`)
pep	boolean	Indica se a pessoa é politicamente exposta

Documento de Identificação (`id_document`)

Objeto contendo os dados do documento oficial da pessoa.

Campo	Tipo	Descrição
number	string	Número do documento
issuer	string	Órgão emissor
issue_date	string	Data de emissão
type	string	Tipo do documento (`CNH`, `PASSPORT`, `RG`, `RNE`)

Informações Pessoais e Profissionais

Campo	Tipo	Descrição
occupation	string	Cargo ou ocupação
marital_status	string	Estado civil
marital_property_system	string	Regime de bens
email_address	string	E-mail de contato
monthly_income	float	Renda mensal estimada
employer	string	Área de atuação / empregador

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	Nome da rua
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

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	Número da conta
bank_account_digit	string	Dígito da conta
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 da chave (`ALEATORY_KEY`, `EMAIL`, `PHONE_NUMBER`, `TAXPAYER_ID`)

Dados do Cônjuge

Campo	Tipo	Descrição
spouse_full_name	string	Nome do cônjuge
spouse_taxpayer_id	string	CPF do cônjuge
spouse_date_of_birth	string	Data de nascimento do cônjuge

Originador (`originator`)

Objeto contendo os dados do Originador vinculado à pessoa.

Campo	Tipo	Descrição
id	string (UUID)	Identificador do Originador
legal_name	string	Nome/Razão Social

Auditoria

Campo	Tipo (ISO 8601)	Descrição
created_at	string	Data/hora de criação
updated_at	string	Data/hora da última atualização
version	integer	Versão do registro

Códigos de Retorno

Código HTTP	Descrição
200 OK	Consulta realizada com sucesso
401 Unauthorized	Token de autenticação ausente ou inválido
403 Forbidden	Cliente não possui permissão para acessar este recurso
500 Internal Server Error	Erro inesperado no servidor