Consultar Pessoas Cadastradas

Este endpoint permite consultar uma lista de pessoas associadas a um Originador, facilitando a integração de sistemas para acesso, leitura e manipulação de dados cadastrais.

Este endpoint permite recuperar informações cadastrais completas das pessoas, incluindo:

• 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

• Dados de auditoria

---

Descrição

Este endpoint permite consultar todas as Pessoas associadas a um Originador.

A operação é exclusivamente de consulta e não altera o estado dos cadastros na plataforma.

A resposta pode ser retornada de forma paginada, de acordo com a quantidade de registros existentes.

---

Método HTTP

GET

---

URL

Plain Text

https://sandbox.auth.flowfinance.com.br/banking/originator/persons

---

Path Parameters

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

---

Query Parameters

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

---

Headers

---

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

Plain Text

GET /banking/originator/persons
Host: sandbox.auth.flowfinance.com.br
Authorization: Bearer {access_token}
Content-Type: application/json

---

Resposta de Sucesso

Status: 200 OK

Retorna a lista de pessoas associadas ao Originador, com informações de paginação.

Exemplo de Resposta

Plain Text

{
  "content": [{
            "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",
            "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,
            "spouse_taxpayer_id": "98765432100",
            "spouse_date_of_birth": "1992-11-22",
            "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"
        },
        ...
        ],
  "total_pages": 1,
  "total_elements": 9,
  "has_next": false
}

---

Estrutura da Resposta

Objeto Principal

---

Objeto content (Lista de Pessoas)

Cada item da lista representa uma Pessoa Física cadastrada.

Identificação Básica

---

Documento de Identificação (id_document)

Objeto contendo os dados do documento oficial da pessoa.

---

Informações Pessoais e Profissionais

---

Telefone (phone)

---

Endereço (address)

---

Conta Bancária Externa (external_bank_account)

---

Chave PIX (pix)

---

Dados do Cônjuge

---

Originador (originator)

Objeto contendo os dados do Originador vinculado à pessoa.

---

Auditoria

---

Códigos de Retorno