Retorna o arquivo físico de um documento previamente enviado e associado ao cadastro de uma Empresa na Plataforma Flow Finance.
Este endpoint permite realizar o download do documento original, possibilitando sua visualização ou armazenamento local.
O retorno consiste diretamente no conteúdo do arquivo, cujo tipo pode variar conforme o documento armazenado (por exemplo: PDF, JPG ou PNG).
Descrição
Este endpoint permite realizar o download de um documento específico, identificado pelo document_id, vinculado ao cadastro de uma Empresa identificada pelo business_id.
A operação é exclusivamente de consulta e não altera o estado do documento ou do cadastro da Empresa.
Método HTTP
GET
URL
https://sandbox.platform.flowfinance.com.br/banking/originator/business/{business_id}/documents/{document_id}/file
Path Parameters
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| business_id | string | Sim | Identificador único (UUID v4) do cadastro da Empresa na Plataforma Flow Finance. Utilizado para garantir que o documento pertence à Empresa correta. |
| document_id | string | Sim | Identificador único (UUID v4) do documento previamente enviado. Permite localizar de forma precisa o arquivo a ser baixado. |
Headers
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| Authorization | string | Sim | Token de autenticação no formato Bearer {token}, responsável por autenticar e autorizar o acesso ao endpoint. |
| 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 /banking/originator/business/587a6c4f-ba39-498a-a689-f20ac0238007/documents/4dbe9ac2-1d4e-40c1-98e2-176b0a9b9549/file
Authorization: Bearer {token}
Content-Type: application/json
Resposta de Sucesso
Status: 200 OK
A requisição foi processada com sucesso e retorna o conteúdo do arquivo correspondente ao documento solicitado.
-
O corpo da resposta contém o arquivo binário.
-
O Content-Type da resposta será definido dinamicamente conforme o tipo do documento armazenado (ex.:
application/pdf,image/jpeg,image/png). -
O arquivo pode ser utilizado diretamente para download ou visualização.
Códigos de Retorno
| Código | Descrição |
|---|---|
| 200 | Documento retornado com sucesso |
| 400 | Parâmetros inválidos na requisição |
| 401 | Não autorizado. Token inválido ou ausente |
| 403 | Acesso negado para o recurso solicitado |
| 404 | Empresa ou documento não encontrados |
| 500 | Erro interno no servidor |