---
title: 1.1. Primeiros Passos
url: https://docs.vehub.com.br/API/Cadastro%20de%20Cedente/1.%20In%C3%ADcio/1.1.%20Primeiros%20Passos/
---
Nesta seção, apresentamos o conjunto de **APIs** que viabilizam o **cadastro de cedentes** na plataforma **VeHub**.

As APIs permitem o gerenciamento completo do cadastro de empresas cedentes, incluindo dados da empresa, pessoas vinculadas (sócios, representantes legais e avalistas), contas correntes, contatos e documentos.

## 1.1.1 Acesso aos Serviços

Para obter acesso aos serviços, entre em contato com nosso time pelo e-mail:

📧 **[contato@vertrau.capital](mailto:contato@vertrau.capital)**

A liberação será realizada tanto para o ambiente de **Homologação (Sandbox)** quanto para o ambiente **Produtivo**.

## 1.1.2 Autenticação e Headers Obrigatórios

Todas as requisições devem incluir os seguintes headers:

| Header | Tipo | Obrigatório | Descrição |
|--------|------|-------------|-----------|
| `Authorization` | Bearer Token | Sim | Token OAuth2 obtido via Keycloak |
| `GrupoEconomico` | string | Sim | Identificador do grupo econômico do cliente |

```
Authorization: Bearer {token}
GrupoEconomico: {grupo-economico}
```

O token é obtido via fluxo OAuth2 fornecido pela Vertrau. Para clients externos, `TipoUsuario` não é exigido.

## 1.1.3 Padrões de Resposta

| Padrão | Formato | Exemplo |
|--------|---------|---------|
| Datas (`DateOnly`) | `YYYY-MM-DD` | `2026-05-13` |
| Datas-hora (`DateTime`) | ISO 8601 | `2026-05-13T14:00:00Z` |
| Enumerações | string (nome do membro do enum) | `"PessoaJuridica"`, `"CNH"` |
| Valores monetários | `number` sem separador de milhar | `15000.00` |
| Atributos | `camelCase` em português | `dataRegistro`, `valorAquisicao` |
| Query strings | case-insensitive | `?indicePagina=1` ou `?IndicePagina=1` |

## 1.1.4 Ambientes

| Ambiente     | URL Base                                  |
|--------------|-------------------------------------------|
| Homologação  | `https://homol-api.vertrau.capital`       |
| Produção     | `https://api.vertrau.capital`             |

## 1.1.5 Visão Geral dos Endpoints

| Método | Endpoint | Descrição |
|--------|----------|-----------|
| ![POST](https://img.shields.io/badge/POST-green) | `/public/api/v1/cedentes` | Criar cadastro de cedente |
| ![GET](https://img.shields.io/badge/GET-blue) | `/public/api/v1/cedentes/{idEmpresa}` | Consultar cadastro completo |
| ![GET](https://img.shields.io/badge/GET-blue) | `/public/api/v1/cedentes/por-documento/{cpfCnpj}` | Resolver cedente por CPF ou CNPJ |
| ![GET](https://img.shields.io/badge/GET-blue) | `/public/api/v1/sacados/por-documento/{cpfCnpj}` | Resolver sacado por CPF ou CNPJ |
| ![PUT](https://img.shields.io/badge/PUT-orange) | `/public/api/v1/cedentes/{idEmpresa}` | Atualizar dados do cedente |
| ![POST](https://img.shields.io/badge/POST-green) | `/public/api/v1/cedentes/{idEmpresa}/pessoas` | Adicionar pessoa vinculada |
| ![PUT](https://img.shields.io/badge/PUT-orange) | `/public/api/v1/cedentes/{idEmpresa}/pessoas/{idPessoa}` | Atualizar pessoa vinculada |
| ![DELETE](https://img.shields.io/badge/DELETE-red) | `/public/api/v1/cedentes/{idEmpresa}/pessoas/{idPessoa}` | Remover pessoa vinculada |
| ![POST](https://img.shields.io/badge/POST-green) | `/public/api/v1/cedentes/{idEmpresa}/contas` | Adicionar conta corrente |
| ![PUT](https://img.shields.io/badge/PUT-orange) | `/public/api/v1/cedentes/{idEmpresa}/contas/{idConta}` | Atualizar conta corrente |
| ![DELETE](https://img.shields.io/badge/DELETE-red) | `/public/api/v1/cedentes/{idEmpresa}/contas/{idConta}` | Remover conta corrente |
| ![POST](https://img.shields.io/badge/POST-green) | `/public/api/v1/cedentes/{idEmpresa}/contatos` | Adicionar contato |
| ![PUT](https://img.shields.io/badge/PUT-orange) | `/public/api/v1/cedentes/{idEmpresa}/contatos/{idContato}` | Atualizar contato |
| ![DELETE](https://img.shields.io/badge/DELETE-red) | `/public/api/v1/cedentes/{idEmpresa}/contatos/{idContato}` | Remover contato |
| ![POST](https://img.shields.io/badge/POST-green) | `/public/api/v1/cedentes/{idEmpresa}/documentos` | Upload de documento |
| ![DELETE](https://img.shields.io/badge/DELETE-red) | `/public/api/v1/cedentes/{idEmpresa}/documentos/{idDocumento}` | Remover documento |