Este endpoint permite enviar um novo documento que será associado ao cadastro de uma Empresa ou à jornada de contratação de crédito na Plataforma.
Durante o processo de Solicitação de Crédito, o sistema valida automaticamente se todos os documentos obrigatórios, definidos na configuração do Produto, foram previamente cadastrados.
Descrição
Este endpoint realiza o upload de um documento para uma Empresa específica, identificada pelo business_id.
O documento enviado passa por validação e processamento interno, podendo ser utilizado posteriormente em análises cadastrais ou de crédito.
A operação cria um novo registro de documento e não substitui versões anteriores, mantendo histórico por versionamento.
Método HTTP
POST
URL
https://sandbox.platform.flowfinance.com.br/banking/originator/business/{business_id}/documents
Path Parameters
| Nome | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| business_id | string (UUID v4) | Sim | Identificador único do cadastro da Empresa à qual o documento será associado. |
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 multipart/form-data. |
Body Parameters (multipart/form-data)
Dados do Documento
| Campo | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| file | file | Sim | Arquivo do documento a ser enviado. |
| type | string | Sim | Tipo do documento (ver lista de tipos aceitos). |
| observations | string | Não | Observações ou comentários adicionais sobre o documento enviado. |
Tipos de Documentos Aceitos (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 |
Exemplo de Requisição
Form-data
POST /credit/api/v1/businesses/c47ea1c9-0f67-429f-a1b7-ace6f6bea704/documents
Authorization: Bearer {token}
Content-Type: multipart/form-data
Body (multipart/form-data):
| Key | Tipo | Value |
|---|---|---|
| file | file | comprovante_endereco.pdf |
| type | text | PROOF_OF_ADDRESS |
| observations | text | Documento atualizado emitido em janeiro de 2026 |
Resposta de Sucesso
Status: 201 Created
Documento enviado e registrado com sucesso.
Exemplo de Resposta
{
"id": "03c1526b-4ea9-40e1-8514-2eb7685c0475",
"type": "PROOF_OF_ADDRESS",
"observations": "Documento atualizado emitido em janeiro de 2026",
"status": "OK",
"file_extension": "pdf",
"file_name": "comprovante_endereco.pdf",
"entity_id": "c47ea1c9-0f67-429f-a1b7-ace6f6bea704",
"created_at": "2026-01-20T16:14:31.268878Z",
"version": 0
}
Estrutura da Resposta
| Campo | Tipo | Descrição |
|---|---|---|
| id | string (UUID v4) | Identificador único do documento. |
| type | string | Tipo do documento enviado. |
| observations | string | Observações associadas ao documento. |
| status | string | Status do processamento do documento. |
| file_extension | string | Extensão do arquivo armazenado. |
| file_name | string | Nome do arquivo armazenado. |
| entity_id | string (UUID v4) | Identificador da entidade (Empresa) associada. |
| created_at | datetime | Data e hora de criação do registro. |
| version | integer | Versão do documento. |
Códigos de Retorno HTTP
| Código | Descrição |
|---|---|
| 201 Created | Documento enviado e registrado com sucesso. |
| 400 Bad Request | Dados inválidos no body ou tipo de documento não suportado. |
| 401 Unauthorized | Token de autenticação ausente, inválido ou expirado. |
| 403 Forbidden | Acesso não autorizado para a Empresa informada. |
| 404 Not Found | Empresa (business_id) não encontrada. |
| 413 Payload Too Large | Arquivo excede o tamanho máximo permitido. |
| 415 Unsupported Media Type | Content-Type diferente de multipart/form-data. |
| 422 Unprocessable Entity | Documento inválido ou regras de negócio não atendidas. |
| 500 Internal Server Error | Erro interno no processamento do documento. |