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
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| business_id | string | Sim | Identificador único (UUID v4) do cadastro da Empresa cujos documentos serão consultados. |
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
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
| Campo | Tipo | Descrição |
|---|---|---|
| — | array | Lista de documentos associados à Empresa |
Objeto Documento
| Campo | Tipo | Descrição |
|---|---|---|
| id | string | Identificador único (UUID v4) do documento |
| type | string | Tipo do documento enviado |
| observations | string | Observações ou comentários sobre o documento |
| status | string | Status de recebimento e validação do documento |
| file_extension | string | Extensão do arquivo (ex: pdf, jpg) |
| file_name | string | Nome do arquivo enviado |
| entity_id | string | Identificador da entidade associada ao documento |
| created_at | string | Data e hora de envio no formato ISO 8601 |
| version | integer | Versão do documento para controle de versionamento |
Tipos de Documentos (type)
type)| Valor | Descrição |
|---|---|
| BALANCE_SHEETS | Balanço Patrimonial |
| INCOME_STATEMENT | Comprovante de Renda |
| PROOF_OF_ADDRESS | Comprovante de Endereço |
| BYLAWS | Estatuto Social |
| INCORPORATION_CERTIFICATE | Registro de Incorporação |
| FEDERAL_REGISTER_CERTIFICATE | Cartão CNPJ |
| INVOICE | Comprovante |
| CERTIFICATE | Certidão |
| LETTER_OF_ATTORNEY | Procuração |
| CONTRACT | Contrato |
| OTHER | Outro |
Códigos de Retorno Padrão
| Código | Descrição |
|---|---|
| 200 OK | Consulta realizada com sucesso |
| 400 Bad Request | Parâmetros inválidos ou malformados |
| 401 Unauthorized | Token de autenticação ausente ou inválido |
| 403 Forbidden | Acesso negado ao recurso solicitado |
| 404 Not Found | Empresa não encontrada para o business_id informado |
| 500 Internal Server Error | Erro interno inesperado na plataforma |