Consultar os documentos da Empresa

Retorna a lista de documentos já enviados e vinculados ao cadastro de uma Empresa na Plataforma Flow Finance.

Este endpoint permite recuperar todas as informações dos documentos associados, incluindo:

  • Tipo do documento

  • Status de validação

  • Nome e extensão do arquivo

  • Data e hora de envio

  • Versão do documento


Descrição

Este endpoint permite consultar todos os documentos enviados para o cadastro de uma Empresa específica, identificada pelo business_id.

A operação é exclusivamente de consulta (GET) e não altera o estado dos documentos ou do cadastro da Empresa.


Método HTTP

GET


URL

https://api.flowfinance.com.br/businesses/{business_id}/documents

Path Parameters

NomeTipoObrigatórioDescrição
business_idstringSimIdentificador único (UUID v4) do cadastro da Empresa cujos documentos serão consultados.

Headers

NomeTipoObrigatórioDescrição
AuthorizationstringSimToken de autenticação no formato Bearer {token}.
Content-TypestringSimDeve ser informado como application/json.

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 /businesses/c47ea1c9-0f67-429f-a1b7-ace6f6bea704/documents
Authorization: Bearer {token}
Content-Type: application/json

Resposta de Sucesso

Status: 200 OK

A requisição foi processada com sucesso e retorna um array JSON contendo os documentos associados à Empresa.

Exemplo de Resposta

[
  {
    "id": "2135ef46-d120-4b10-bfb0-ea2136f7be10",
    "type": "BYLAWS",
    "observations": null,
    "status": "OK",
    "file_extension": "pdf",
    "file_name": "documento_social.pdf",
    "entity_id": "c47ea1c9-0f67-429f-a1b7-ace6f6bea704",
    "created_at": "2026-01-20T14:45:58.4745Z",
    "version": 0
  },
  {
    "id": "cf40e191-7afc-4686-87db-67490d61cd45",
    "type": "PROOF_OF_ADDRESS",
    "observations": null,
    "status": "OK",
    "file_extension": "pdf",
    "file_name": "comprovante_endereco.pdf",
    "entity_id": "c47ea1c9-0f67-429f-a1b7-ace6f6bea704",
    "created_at": "2026-01-20T14:46:09.513978Z",
    "version": 0
  }
]

Estrutura do Response

Objeto Raiz

CampoTipoDescrição
arrayLista de documentos associados à Empresa

Objeto Documento

CampoTipoDescrição
idstringIdentificador único (UUID v4) do documento
typestringTipo do documento enviado
observationsstringObservações ou comentários sobre o documento
statusstringStatus de recebimento e validação do documento
file_extensionstringExtensão do arquivo (ex: pdf, jpg)
file_namestringNome do arquivo enviado
entity_idstringIdentificador da entidade associada ao documento
created_atstringData e hora de envio no formato ISO 8601
versionintegerVersão do documento para controle de versionamento

Tipos de Documentos (type)

ValorDescrição
BALANCE_SHEETSBalanço Patrimonial
INCOME_STATEMENTComprovante de Renda
PROOF_OF_ADDRESSComprovante de Endereço
BYLAWSEstatuto Social
INCORPORATION_CERTIFICATERegistro de Incorporação
FEDERAL_REGISTER_CERTIFICATECartão CNPJ
INVOICEComprovante
CERTIFICATECertidão
LETTER_OF_ATTORNEYProcuração
CONTRACTContrato
OTHEROutro

Códigos de Retorno Padrão

CódigoDescrição
200 OKConsulta realizada com sucesso
400 Bad RequestParâmetros inválidos ou malformados
401 UnauthorizedToken de autenticação ausente ou inválido
403 ForbiddenAcesso negado ao recurso solicitado
404 Not FoundEmpresa não encontrada para o business_id informado
500 Internal Server ErrorErro interno inesperado na plataforma
Language
URL
Click Try It! to start a request and see the response here!