Retorna a lista de Empresas cadastradas e associadas a um Originador na Plataforma.
Este endpoint permite recuperar informações cadastrais completas das Empresas, com suporte a filtros opcionais e paginação.
As informações retornadas incluem, entre outras:
-
Dados cadastrais da Empresa
-
Informações fiscais e tributárias
-
Dados de contato (telefone e endereço)
-
Configurações de PIX
-
Conta bancária externa
-
Metadados e versionamento
Descrição
Este endpoint permite consultar as Empresas vinculadas a um Originador, retornando os resultados de forma paginada.
A operação é exclusivamente de consulta e não altera o estado dos registros.
Filtros opcionais podem ser utilizados para restringir os resultados com base em informações cadastrais da Empresa.
Método HTTP
GET
URL
https://sandbox.platform.flowfinance.com.br/banking/originator/business
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 |
Query Parameters (Opcionais)
| Nome | Tipo | Descrição |
|---|---|---|
| taxpayer_id | string | CNPJ da Empresa a ser consultada |
| legal_name | string | Razão social da Empresa |
| page | integer | Número da página para navegação dos resultados |
| size | integer | Quantidade de registros retornados por página |
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 /originators/companies?taxpayer_id=81435052000192&page=0&size=10
Authorization: Bearer {token}
Content-Type: application/json
Resposta de Sucesso
Status: 200 OK
A requisição foi processada com sucesso e retorna um objeto JSON contendo os dados paginados das Empresas associadas ao Originador.
Exemplo de Resposta
{
"content": [
{
"id": "587a6c4f-ba39-498a-a689-f20ac0238007",
"legal_name": "SOLUCOES DIGITAIS ALFA LTDA",
"taxpayer_id": "81435052000192",
"name": "Alfa Digital",
"email_address": "[email protected]",
"incorporation_type": "LTDA",
"tax_regime": "SIMPLE",
"industry_classification": "6201501",
"phone": {
"country_code": "55",
"area_code": "21",
"number": "988776655",
"formatted_number": "+5521988776655"
},
"address": {
"street_name": "Avenida das Américas",
"street_number": 1200,
"district": "Barra da Tijuca",
"city": "Rio de Janeiro",
"state_code": "RJ",
"postal_code": "22640102",
"country_code": "BRA"
},
"pix": {
"key": "81435052000192",
"key_type": "TAXPAYER_ID"
},
"external_bank_account": {
"bank_code": "001",
"bank_branch": "1234",
"bank_account": "456789",
"bank_account_digit": "0",
"ispb_code": "00000000"
},
"created_at": "2026-01-20T02:20:29.518352Z",
"version": 0,
"employer": false,
"custodian": false
}
],
"total_pages": 1,
"total_elements": 8,
"has_next": false
}
Códigos de Retorno
| Código | Descrição |
|---|---|
| 200 OK | Consulta realizada com sucesso |
| 400 Bad Request | Parâmetros de consulta inválidos |
| 401 Unauthorized | Token de autenticação ausente, inválido ou expirado |
| 403 Forbidden | Acesso não permitido para o Originador informado |
| 404 Not Found | Originador não encontrado |
| 422 Unprocessable Entity | Parâmetros informados não atendem às regras de validação |
| 500 Internal Server Error | Erro inesperado no servidor |