Exclui definitivamente um documento previamente cadastrado e associado ao cadastro de uma Empresa na Plataforma.
Após a exclusão, o documento deixa de ser considerado nas validações da jornada de contratação de crédito e não poderá ser recuperado.
Este endpoint realiza uma operação destrutiva e remove permanentemente o documento informado.
Descrição
Este endpoint permite excluir um documento específico, identificado pelo document_id, vinculado ao cadastro de uma Empresa identificada pelo business_id.
A operação remove o documento de forma definitiva do cadastro da Empresa.
Após a exclusão, o documento não será mais retornado nos endpoints de listagem ou consulta.
Método HTTP
DELETE
URL
https://sandbox.platform.flowfinance.com.br/banking//originator/business/{business_id}/documents/{document_id}
Path Parameters
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| business_id | string (UUID v4) | Sim | Identificador único do cadastro da Empresa à qual o documento está associado. |
| document_id | string (UUID v4) | Sim | Identificador único do documento que será excluído. |
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. |
Body Parameters
Este endpoint não possui corpo de requisição, pois se trata de uma operação de exclusão (DELETE).
Exemplo de Requisição
DELETE /banking/originator/business/c47ea1c9-0f67-429f-a1b7-ace6f6bea704/documents/d7e11ae5-2252-4c12-bb0e-27e2d86ee034
Authorization: Bearer {token}
Content-Type: application/json
Resposta de Sucesso
Status: 200 OK
Confirma que o documento foi excluído com sucesso do cadastro da Empresa.
<p >Este endpoint não retorna corpo na resposta.</p>
Códigos de Retorno HTTP
| Código | Descrição |
|---|---|
| 200 OK | Documento excluído com sucesso. |
| 400 Bad Request | Parâmetros inválidos ou mal formatados (ex: UUID inválido). |
| 401 Unauthorized | Token de autenticação ausente, inválido ou expirado. |
| 403 Forbidden | O token não possui permissão para excluir documentos dessa Empresa. |
| 404 Not Found | Empresa ou documento não encontrado, ou documento não pertence à Empresa informada. |
| 409 Conflict | Documento não pode ser excluído devido a regras de negócio (ex: em uso em um processo ativo). |
| 500 Internal Server Error | Erro inesperado na plataforma. |
Comportamento Pós-Exclusão
Após a exclusão, ao consultar novamente a lista de documentos da Empresa por meio do endpoint de listagem, o documento removido não será mais retornado.
Exemplo de Resposta GET (antes do DELETE)
[
{
"id": "d7e11ae5-2252-4c12-bb0e-27e2d86ee034",
"type": "BALANCE_SHEETS",
"status": "OK",
"file_name": "balanco_patrimonial_teste_v.2.pdf"
},
{
"id": "ae6d9585-8549-4be5-8f30-2299292821e6",
"type": "BYLAWS",
"status": "OK",
"file_name": "estatuto_social_teste_v.2.pdf"
}
]
Exemplo de Resposta GET (após o DELETE)
[
{
"id": "ae6d9585-8549-4be5-8f30-2299292821e6",
"type": "BYLAWS",
"status": "OK",
"file_name": "estatuto_social_teste_v.2.pdf"
}
]