--- title: 5.1. Upload e Gerenciamento de Documentos url: https://docs.vehub.com.br/API/Cadastro%20de%20Cedente/5.%20Documentos/5.1.%20Upload%20e%20Gerenciamento%20de%20Documentos/ --- Gerenciamento dos documentos do cedente e de suas pessoas vinculadas. --- ## Upload de Documento | Método | URL | | ------------------------------------------------ | ------------------------------------------------------ | | ![POST](https://img.shields.io/badge/POST-green) | `https://BASE_URL/public/api/v1/cedentes/{idEmpresa}/documentos` | O envio do documento é feito via `multipart/form-data`. ```bash title="Request — cURL" curl -X POST https://BASE_URL/public/api/v1/cedentes/123/documentos \ -H "Authorization: Bearer {token}" \ -H "Content-Type: multipart/form-data" \ -F "arquivo=@/caminho/para/contrato_social.pdf" \ -F "tipoDocumentoIntegracao=1" \ -F "idEmpresaPessoa=" \ -F "observacao=Contrato social consolidado 2025" ``` ```json title="Response Body" { "idDocumento": 78, "idEmpresa": 123, "arquivoNome": "contrato_social.pdf", "tipoDocumentoIntegracao": 1, "statusDocumento": 1, "status": "Documento enviado com sucesso." } ``` --- ## Remover Documento | Método | URL | | -------------------------------------------------- | -------------------------------------------------------------------- | | ![DELETE](https://img.shields.io/badge/DELETE-red) | `https://BASE_URL/public/api/v1/cedentes/{idEmpresa}/documentos/{idDocumento}` | ```json title="Response Body" { "status": "Documento removido com sucesso." } ``` --- # Modelo de Dados ## Requisição — Documento (multipart/form-data) | Campo | Tipo | Obrigatório | Descrição | | ------------------------- | ----------------- | :---------: | ------------------------------------------------------------------------------------------------------------------------ | | `arquivo` | Arquivo (binário) | ✅ | Arquivo do documento (extensões aceitas: `pdf`, `jpg`, `jpeg`, `png`) | | `tipoDocumentoIntegracao` | Número (enum) | ✅ | Tipo do documento. Ver [Tipo de Documento](../1.%20In%C3%ADcio/1.3.%20Dicion%C3%A1rio%20de%20Dados.md#tipo-de-documento). Valores aceitos: `1..10`. | | `idEmpresaPessoa` | Número | Opcional | ID da pessoa vinculada. Quando informado, o documento é classificado como pertencente à pessoa (categoria `DocumentosPessoais`); a pessoa precisa existir e pertencer ao mesmo cedente. Quando omitido, o documento é classificado como documento da empresa. | | `observacao` | Texto | Opcional | Observação sobre o documento | ## Retorno | Campo | Tipo | Descrição | | ------------------------- | ------ | ------------------------------------------------------------------------------------------------------------------------------------ | | `idDocumento` | Número | ID do documento | | `idEmpresa` | Número | ID da empresa cedente | | `arquivoNome` | Texto | Nome do arquivo enviado | | `tipoDocumentoIntegracao` | String (enum) | Tipo do documento (nome técnico do enum, ex.: `"CNH"`, `"BalancoPatrimonial"`). Ver [Tipo de Documento](../1.%20In%C3%ADcio/1.3.%20Dicion%C3%A1rio%20de%20Dados.md#tipo-de-documento). | | `statusDocumento` | String (enum) | Status atual do documento (nome técnico do enum, ex.: `"CriadoAguardandoEnvio"`). Ver [Status do Documento](../1.%20In%C3%ADcio/1.3.%20Dicion%C3%A1rio%20de%20Dados.md#status-do-documento). | | `status` | Texto | Mensagem de status da operação | --- ## Documentos Obrigatórios > Os códigos abaixo correspondem aos valores do enum `TipoDocumentoCedenteApiPublica` (também listado em `1.3. Dicionário de Dados.md`). **Use sempre o mesmo código** independentemente de o documento pertencer à empresa ou a uma pessoa vinculada — a categoria é definida pela presença ou ausência de `idEmpresaPessoa` no upload. ### Documentos da Empresa (sem `idEmpresaPessoa`) | Código | Nome técnico | Descrição | Obrigatório | | -----: | ------------------- | -------------------------------------------- | :----------: | | `1` | `ContratoSocial` | Contrato Social | ✅ | | `9` | `EstatutoSocial` | Estatuto Social | Condicional¹ | | `10` | `AtaEleicaoAssembleia` | Ata de Eleição / Assembleia | Condicional¹ | | `6` | `BalancoPatrimonial`| Balanço Patrimonial | ✅ | | `7` | `DRE` | DRE — Demonstração do Resultado do Exercício | ✅ | | `5` | `Procuracao` | Procuração | Opcional | ### Documentos da Pessoa Vinculada (com `idEmpresaPessoa`) | Código | Nome técnico | Descrição | Obrigatório | | -----: | ------------------- | ------------------------ | :---------: | | `2` | `CNH` | CNH | ✅² | | `3` | `RGFrente` | RG — Frente | ✅² | | `4` | `RGVerso` | RG — Verso | ✅² | | `8` | `ComprovanteEndereco`| Comprovante de Endereço | ✅ | !!! note "Notas" ¹ Obrigatório para Sociedade Anônima (S.A.). ² CNH substitui RG — envie CNH **ou** RG (frente + verso).