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:
A liberação será realizada tanto para o ambiente de Homologação (Sandbox) quanto para o ambiente Produtivo.
1.1.2 Autenticação¶
Todas as requisições devem incluir o header de autenticação:
Authorization: Bearer {token}
O token é obtido via fluxo OAuth2 fornecido pela Vertrau.
1.1.3 Ambientes¶
| Ambiente | URL Base |
|---|---|
| Homologação | https://homol-api.vertrau.capital |
| Produção | https://api.vertrau.capital |
1.1.4 Visão Geral dos Endpoints¶
| Método | Endpoint | Descrição |
|---|---|---|
 | /api/cedentes | Criar cadastro de cedente |
 | /api/cedentes/{idEmpresa} | Consultar cadastro completo |
 | /api/cedentes/{idEmpresa} | Atualizar dados do cedente |
| /api/cedentes/{idEmpresa}/pessoas | Adicionar pessoa vinculada |
| /api/cedentes/{idEmpresa}/pessoas/{idPessoa} | Atualizar pessoa vinculada |
 | /api/cedentes/{idEmpresa}/pessoas/{idPessoa} | Remover pessoa vinculada |
| /api/cedentes/{idEmpresa}/contas | Adicionar conta corrente |
| /api/cedentes/{idEmpresa}/contas/{idConta} | Atualizar conta corrente |
| /api/cedentes/{idEmpresa}/contas/{idConta} | Remover conta corrente |
| /api/cedentes/{idEmpresa}/contatos | Adicionar contato |
| /api/cedentes/{idEmpresa}/contatos/{idContato} | Atualizar contato |
| /api/cedentes/{idEmpresa}/contatos/{idContato} | Remover contato |
| /api/cedentes/{idEmpresa}/documentos | Upload de documento |
| /api/cedentes/{idEmpresa}/documentos/{idDocumento} | Remover documento |