Consultar Empresa por ID

get

https://sandbox.auth.flowfinance.com.br/banking/originator/business/{business_id}

Consulta os dados cadastrais de uma Empresa (Business) previamente registrada na plataforma, a partir do seu identificador único (business_id).

Uma Empresa representa uma companhia cadastrada na plataforma e contém informações cadastrais, endereço, dados bancários e configurações adicionais.

Descrição

Este endpoint permite consultar todas as informações cadastrais de uma Empresa já registrada na Plataforma, retornando:

Dados cadastrais da Empresa
Endereço principal
Dados bancários
Chave PIX
Informações adicionais de controle e versionamento

Headers

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

URL Parameters (Path Parameters)

Parâmetro	Tipo	Obrigatório	Descrição
business_id	string (UUID v4)	Sim	Identificador único da Empresa a ser consultada. Esse valor é gerado no momento do cadastro da Empresa na plataforma.

Query Parameters

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

Body Parameters

Este endpoint não requer corpo (body).

A consulta é realizada exclusivamente por meio do parâmetro de rota (business_id).

Exemplo de Requisição

GET /banking/originator/business/587a6c4f-ba39-498a-a689-f20ac0238007
Host: sandbox.platform.flowfinance.com.br
Authorization: Bearer {{access_token}}

Resposta de Sucesso

Status: 200 OK

Retorna um objeto JSON contendo todas as informações cadastrais da Empresa.

Exemplo de Resposta

{
  "id": "587a6c4f-ba39-498a-a689-f20ac0238007",
  "legal_name": "SOLUCOES DIGITAIS ALFA LTDA",
  "taxpayer_id": "81435052000192",
  "phone": {
    "country_code": "55",
    "area_code": "21",
    "number": "988776655",
    "formatted_number": "+5521988776655"
  },
  "incorporation_type": "LTDA",
  "tax_regime": "SIMPLE",
  "industry_classification": "6201501",
  "name": null,
  "email_address": "[email protected]",
  "foundation_date": null,
  "address": {
    "street_name": "Avenida das Américas",
    "street_number": 1200,
    "postal_code": "22640102",
    "district": "Barra da Tijuca",
    "city": "Rio de Janeiro",
    "state_code": "RJ",
    "country_code": "BRA",
    "extra_info": null
  },
  "pix": {
    "key": "81435052000192",
    "key_type": "TAXPAYER_ID"
  },
  "external_bank_account": {
    "bank_code": "001",
    "bank_account": "456789",
    "bank_account_digit": "0",
    "bank_branch": "1234",
    "bank_account_type": null,
    "ispb_code": "00000000"
  },
  "custom_variables": {},
  "created_at": "2026-01-20T02:20:29.518352Z",
  "version": 0,
  "billing_address": null,
  "share_capital": null,
  "monthly_revenue": null,
  "income_range": null,
  "has_scr_evidence": false,
  "scr_evidence_provider": null,
  "scr_evidence_type": null,
  "custodian": false,
  "employer": false
}

Descrição dos Campos da Resposta

Dados Gerais da Empresa

Campo	Tipo	Descrição
id	string (UUID)	Identificador único do cadastro da Empresa na plataforma.
legal_name	string	Razão social registrada na Receita Federal.
name	string	Nome fantasia da Empresa.
taxpayer_id	string	Número do CNPJ da Empresa (somente números).
email_address	string	E-mail principal para contato com a Empresa.
foundation_date	string	Data de abertura da Empresa na Receita Federal (ISO 8601).
incorporation_type	string	Natureza jurídica da Empresa (ex: LTDA, SA).
tax_regime	string	Regime tributário da Empresa (ex: SIMPLE, PRESUMED, REAL).
industry_classification	string	Código CNAE da atividade principal da Empresa.
created_at	string	Data e hora de criação do cadastro da Empresa (UTC, ISO 8601).
version	number	Versão atual do cadastro da Empresa.
employer	boolean	Indica se a Empresa pode possuir colaboradores vinculados.

Phone (Objeto)

Campo	Tipo	Descrição
country_code	string	Código internacional do país (DDI).
area_code	string	Código de área (DDD).
number	string	Número do telefone sem formatação.
formatted_number	string	Número de telefone formatado com DDI e DDD.

Address (Objeto)

Campo	Tipo	Descrição
street_name	string	Nome do logradouro.
street_number	integer	Número do endereço.
extra_info	string	Complemento do endereço.
district	string	Bairro.
city	string	Cidade.
state_code	string	Sigla do estado (UF).
postal_code	string	CEP.
country_code	string	Código do país (ISO 3166-1 alpha-3).

Pix (Objeto)

Campo	Tipo	Descrição
key	string	Valor da chave PIX.
key_type	string	Tipo da chave PIX (ex: TAXPAYER_ID, EMAIL, PHONE, RANDOM).

External Bank Account (Objeto)

Campo	Tipo	Descrição
bank_code	string	Código do banco (COMPE).
bank_branch	string	Número da agência bancária.
bank_account	string	Número da conta bancária.
bank_account_digit	string	Dígito verificador da conta.
bank_account_type	string	Tipo da conta bancária (ex: CHECKING, SAVINGS).
ispb_code	string	Código ISPB da instituição financeira.

Outros Campos

Campo	Tipo	Descrição
billing_address	object	Endereço de cobrança da Empresa, quando diferente do principal.
share_capital	number	Capital social da Empresa.
monthly_revenue	number	Faturamento mensal estimado.
custom_variables	object	Variáveis personalizadas definidas pelo integrador.

Códigos de Erro Possíveis

Código HTTP	Descrição
200 OK	Consulta realizada com sucesso.
400 Bad Request	Parâmetro `business_id` inválido ou mal formatado.
401 Unauthorized	Token de autenticação ausente ou inválido.
403 Forbidden	O cliente não possui permissão para acessar este recurso.
404 Not Found	Empresa não encontrada para o `business_id` informado.
500 Internal Server Error	Erro inesperado no servidor.