Consultar Empresa por ID

StartFragment

Retorna os dados cadastrais de uma Empresa (Business) previamente registrada na plataforma, identificada de forma única pelo business_id.

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

  • Dados cadastrais

  • Endereço principal

  • Dados bancários

  • Chave PIX

  • Informações adicionais de controle e versionamento


Descrição

Este endpoint permite consultar uma Empresa específica, identificada pelo business_id.

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


Método HTTP

GET


URL

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

Path Parameters

NomeTipoObrigatórioDescrição
business_idstring (UUID v4)SimIdentificador único da Empresa previamente cadastrada na plataforma. Utilizado para localizar de forma precisa o cadastro a ser consultado.

Query Parameters

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


Headers

NomeTipoObrigatórioDescrição
AuthorizationstringSimToken de autenticação no formato Bearer {token}, responsável por autenticar e autorizar o acesso ao endpoint.
Content-TypestringSimDeve ser informado como application/json.

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/business/587a6c4f-ba39-498a-a689-f20ac0238007
Host: sandbox.platform.flowfinance.com.br
Authorization: Bearer {token}
Content-Type: application/json

Resposta de Sucesso

Status: 200 OK

Retorna os dados completos da Empresa consultada.

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
}

Códigos de Retorno

Código HTTPDescrição
200 OKConsulta realizada com sucesso.
400 Bad Requestbusiness_id inválido ou mal formatado.
401 UnauthorizedToken de autenticação ausente ou inválido.
403 ForbiddenO cliente não possui permissão para acessar este recurso.
404 Not FoundEmpresa não encontrada para o business_id informado.
500 Internal Server ErrorErro inesperado no servidor.
Language
URL
Click Try It! to start a request and see the response here!