Ir para o conteúdo

6.4. Avalistas

Especificação — em construção

Os serviços descritos nesta área ainda não estão disponíveis.

Etapa opcional

A proposta avança sem avalista. Inclua apenas quando a política da operação exigir.

🔗 Endpoints

Método URL
POST /credito/propostas/{idProposta}/avalistas
GET /credito/propostas/{idProposta}/avalistas
GET /credito/propostas/{idProposta}/avalistas/{idAvalista}
PUT /credito/propostas/{idProposta}/avalistas/{idAvalista}
DELETE /credito/propostas/{idProposta}/avalistas/{idAvalista}

🧾 Descrição

Cadastra pessoas físicas que garantem a dívida do tomador. Internamente, o avalista é registrado como uma garantia do tipo Fiador — pessoa física, e aparece também na listagem de garantias.

Criar avalista

📤 Requisição

{
  "nome": "Carlos Pereira",
  "documento": "11122233344",
  "dataNascimento": "1975-06-30",
  "telefone": "47988887777",
  "email": "carlos@exemplo.com",
  "estadoCivil": 1,
  "nomeMae": "Rita Pereira",
  "cnpjEmpresa": "12345678000199",
  "renda": 9000.00,
  "dataAdmissao": "2015-01-10",
  "idOcupacao": 12,
  "endereco": {
    "cep": "89010000",
    "endereco": "Rua A",
    "numero": "10",
    "bairro": "Centro",
    "cidade": "Blumenau",
    "uf": "SC"
  }
}

🧾 Detalhamento dos Campos

Campo Tipo Obrigatório Descrição
nome string Sim Nome completo
documento string Sim CPF, somente dígitos. Validado
dataNascimento string Sim YYYY-MM-DD. Não pode ser data futura
telefone string Sim Somente dígitos, com DDD
email string Sim E-mail válido
estadoCivil integer Não Ver GET /enumeracoes/estado-civil
nomeMae string Não Nome completo da mãe
cnpjEmpresa string Não CNPJ do empregador do avalista
renda number Não Renda mensal declarada
dataAdmissao string Não Data de admissão no empregador
idOcupacao integer Não Ver GET /enumeracoes/ocupacoes
endereco object Sim Endereço completo

🧪 Exemplo de cURL

curl -X POST "https://api.vehub.com.br/credito/propostas/1001/avalistas" \
  -H "Authorization: Bearer {seu_token}" \
  -H "GrupoEconomico: {seu_grupo_economico}" \
  -H "Content-Type: application/json" \
  -d @avalista.json

📥 Response — 201 Created

{
  "sucesso": true,
  "mensagem": "Avalista incluído com sucesso.",
  "dados": { "idAvalista": 3 }
}

Listar avalistas

📥 Response — 200 OK

{
  "registros": [
    { "id": 3, "nome": "Carlos Pereira", "documento": "11122233344", "tipoGarantia": "Fiador - PF" }
  ],
  "paginacao": { "pagina": 1, "quantidade": 50, "total": 1 },
  "mensagem": null
}

Consultar avalista

GET /credito/propostas/{idProposta}/avalistas/{idAvalista} devolve o objeto completo, no mesmo formato do payload de criação, com o id.

Atualizar avalista

PUT com o mesmo payload da criação. Substitui os dados do avalista informado.

Excluir avalista

DELETE /credito/propostas/{idProposta}/avalistas/{idAvalista}

📥 Response — 200 OK

{
  "sucesso": true,
  "mensagem": "Avalista removido com sucesso.",
  "dados": null
}

⚠️ O avalista não assina a CCB

No fluxo atual, somente o tomador (ou os representantes legais, se pessoa jurídica) assina o instrumento. O avalista é registrado como garantia, mas não entra na lista de assinantes e não recebe convite de assinatura.

Se a sua operação depende da assinatura do avalista, isso precisa ser tratado fora desta jornada — fale com o nosso time.

⚠️ Observações

  • Avalistas não têm documentos exigidos próprios na coleta da proposta. A lista de documentos é montada a partir do tomador e das pessoas vinculadas a ele.
  • Alterações em avalistas são permitidas enquanto a proposta não foi enviada à bancarizadora.
  • O avalista também aparece em 6.5. Garantias, com tipoGarantia igual a Fiador - PF. As duas visões enxergam o mesmo registro.