1.1. Primeiros Passos

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

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
	`/public/api/v1/cedentes`	Criar cadastro de cedente
	`/public/api/v1/cedentes/{idEmpresa}`	Consultar cadastro completo
	`/public/api/v1/cedentes/{idEmpresa}`	Atualizar dados do cedente
	`/public/api/v1/cedentes/{idEmpresa}/pessoas`	Adicionar pessoa vinculada
	`/public/api/v1/cedentes/{idEmpresa}/pessoas/{idPessoa}`	Atualizar pessoa vinculada
	`/public/api/v1/cedentes/{idEmpresa}/pessoas/{idPessoa}`	Remover pessoa vinculada
	`/public/api/v1/cedentes/{idEmpresa}/contas`	Adicionar conta corrente
	`/public/api/v1/cedentes/{idEmpresa}/contas/{idConta}`	Atualizar conta corrente
	`/public/api/v1/cedentes/{idEmpresa}/contas/{idConta}`	Remover conta corrente
	`/public/api/v1/cedentes/{idEmpresa}/contatos`	Adicionar contato
	`/public/api/v1/cedentes/{idEmpresa}/contatos/{idContato}`	Atualizar contato
	`/public/api/v1/cedentes/{idEmpresa}/contatos/{idContato}`	Remover contato
	`/public/api/v1/cedentes/{idEmpresa}/documentos`	Upload de documento
	`/public/api/v1/cedentes/{idEmpresa}/documentos/{idDocumento}`	Remover documento