6.5. Garantias¶

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 garantia. Inclua apenas quando a política da operação exigir.

🔗 Endpoints¶

Método	URL
	`/credito/propostas/{idProposta}/garantias`
	`/credito/propostas/{idProposta}/garantias`
	`/credito/propostas/{idProposta}/garantias/{idGarantia}`
	`/credito/propostas/{idProposta}/garantias/{idGarantia}`
	`/credito/propostas/{idProposta}/garantias/{idGarantia}`
	`/credito/propostas/{idProposta}/garantias/{idGarantia}/documentos`
	`/credito/propostas/{idProposta}/garantias/{idGarantia}/documentos/{idDocumento}`
	`/credito/propostas/{idProposta}/garantias/{idGarantia}/documentos/{idDocumento}/download`

🧾 Descrição¶

Registra os bens ou direitos dados em garantia da operação, com os anexos correspondentes.

O objeto é polimórfico: os campos que você deve preencher dependem do idTipoGarantia. Campos de outros tipos são ignorados.

📦 Formato da requisição¶

multipart/form-data, com duas partes:

Parte	Tipo	Descrição
`dados`	JSON (string)	O objeto da garantia, conforme o tipo
`arquivo`	binário	Documento da garantia. Opcional na criação

Tipos de garantia¶

Código	Descrição	Bloco de campos
`1`	Cessão fiduciária	genérico
`2`	Alienação fiduciária	genérico
`3`	Hipoteca	imóvel
`4`	Fiador — pessoa física	pessoas
`5`	Fiador — pessoa jurídica	empresa
`6`	Estoque ou maquinário	estoque
`7`	Outros	genérico
`8`	Recebíveis	genérico
`9`	Imóvel	imóvel
`10`	Veículo	veículo
`11`	Devedor solidário	pessoas

Quais tipos a sua esteira aceita

A lista acima é o enumerador completo da plataforma, compartilhado com outros produtos. Os tipos efetivamente utilizados nas esteiras de crédito são um subconjunto — consulte GET /enumeracoes/tipo-garantia e, em dúvida, alinhe com o nosso time antes de implementar um tipo específico.

O tipo 4 é o usado pela etapa de avalistas: um avalista criado lá aparece aqui na listagem.

Campos comuns¶

Campo	Tipo	Obrigatório	Descrição
idTipoGarantia	integer	Sim	Ver tabela acima
descricao	string	Sim	Descrição livre da garantia
garantiaPropriedadeDoEmitente	boolean	Não	Indica se o bem é do próprio tomador
proprietario	object	Condicional	Quando o bem não é do tomador: `{ nome, documento }`
possuiFielDepositario	boolean	Não
fielDepositario	object	Condicional	`{ nome, documento }` quando `possuiFielDepositario = true`
possuiAgenteDeGarantias	boolean	Não
agenteDeGarantias	object	Condicional	`{ nome, documento }` quando `possuiAgenteDeGarantias = true`

📋 Payload — Veículo (`10`)¶

{
  "idTipoGarantia": 10,
  "descricao": "Veículo em alienação fiduciária",
  "veiculoTipo": "Automóvel",
  "veiculoMarca": "VW",
  "veiculoModelo": "Nivus",
  "veiculoAno": 2023,
  "veiculoCor": "Prata",
  "veiculoPlaca": "ABC1D23",
  "veiculoRenavam": "00123456789",
  "veiculoChassi": "9BWZZZ377VT004251",
  "veiculoValor": 95000.00,
  "garantiaPropriedadeDoEmitente": true,
  "possuiFielDepositario": false,
  "possuiAgenteDeGarantias": false
}

Campo	Tipo	Descrição
veiculoTipo	string	Automóvel, motocicleta, caminhão...
veiculoMarca	string	Marca
veiculoModelo	string	Modelo
veiculoAno	integer	Ano do modelo
veiculoCor	string	Cor predominante
veiculoPlaca	string	Placa
veiculoRenavam	string	RENAVAM
veiculoChassi	string	Chassi
veiculoValor	number	Valor de avaliação

📋 Payload — Imóvel (`9`) ou Hipoteca (`3`)¶

{
  "idTipoGarantia": 9,
  "descricao": "Imóvel residencial em hipoteca",
  "imovelMatricula": "45.678",
  "imovelNumeroLaudo": "LAUDO-2026-114",
  "garantiaPropriedadeDoEmitente": false,
  "proprietario": { "nome": "Marta Souza", "documento": "22233344455" }
}

Campo	Tipo	Descrição
imovelMatricula	string	Matrícula no registro de imóveis
imovelNumeroLaudo	string	Número do laudo de avaliação

📋 Payload — Estoque ou maquinário (`6`)¶

{
  "idTipoGarantia": 6,
  "descricao": "Empilhadeira",
  "estoqueOuMaquinarioPropostaNotaFiscal": "NF-8842",
  "estoqueOuMaquinarioQuantidade": 1,
  "estoqueOuMaquinarioDescricao": "Empilhadeira elétrica 2t",
  "estoqueOuMaquinarioNumeroSerie": "SN-99123",
  "estoqueOuMaquinarioValorUnitario": 78000.00,
  "estoqueOuMaquinarioEndereco": {
    "cep": "89010000",
    "endereco": "Rua B",
    "numero": "50",
    "bairro": "Industrial",
    "cidade": "Blumenau",
    "uf": "SC"
  },
  "possuiFielDepositario": true,
  "fielDepositario": { "nome": "José Silva", "documento": "11122233344" }
}

Campo	Tipo	Descrição
estoqueOuMaquinarioPropostaNotaFiscal	string	Nota fiscal do bem
estoqueOuMaquinarioQuantidade	integer	Quantidade
estoqueOuMaquinarioDescricao	string	Descrição do bem
estoqueOuMaquinarioNumeroSerie	string	Número de série
estoqueOuMaquinarioValorUnitario	number	Valor unitário
estoqueOuMaquinarioEndereco	object	Onde o bem está localizado

📋 Payload — Fidejussória (`4`, `5`, `11`)¶

Garantias pessoais usam pessoas (para PF) ou empresa (para PJ):

{
  "idTipoGarantia": 11,
  "descricao": "Devedor solidário",
  "pessoas": [
    { "nome": "Carlos Pereira", "documento": "11122233344" }
  ]
}

Para fiador pessoa física, prefira a etapa de avalistas, que já coleta a ficha completa da pessoa.

🧪 Exemplo de cURL¶

curl -X POST "https://api.vehub.com.br/credito/propostas/1001/garantias" \
  -H "Authorization: Bearer {seu_token}" \
  -H "GrupoEconomico: {seu_grupo_economico}" \
  -F 'dados={"idTipoGarantia":10,"descricao":"Veículo em alienação fiduciária","veiculoPlaca":"ABC1D23","veiculoValor":95000.00};type=application/json' \
  -F "arquivo=@crlv.pdf"

📥 Responses¶

✅ 201 Created¶

{
  "sucesso": true,
  "mensagem": "Garantia incluída com sucesso.",
  "dados": { "idGarantia": 12 }
}

✅ 200 OK — listagem¶

{
  "registros": [
    { "id": 12, "tipoGarantia": "Veículo", "descricao": "Veículo em alienação fiduciária" },
    { "id": 3, "tipoGarantia": "Fiador - PF", "descricao": "Carlos Pereira" }
  ],
  "paginacao": { "pagina": 1, "quantidade": 50, "total": 2 },
  "mensagem": null
}

Documentos da garantia¶

Cada garantia pode ter vários anexos.

Operação	Endpoint
Anexar	`POST .../garantias/{idGarantia}/documentos` — `multipart/form-data`, campo `arquivo`
Remover	`DELETE .../garantias/{idGarantia}/documentos/{idDocumento}`
Baixar	`GET .../garantias/{idGarantia}/documentos/{idDocumento}/download`

O download devolve o arquivo com o Content-Type original.

Extensões aceitas: pdf, jpg, png, docx, xlsx.

⚠️ Observações¶

A garantia não assina a CCB. Nem o proprietário do bem, nem o fiel depositário, nem o agente de garantias entram na lista de assinantes.
Garantias podem ser incluídas, alteradas e removidas enquanto a proposta não foi enviada à bancarizadora.
As garantias não aparecem na coleta de documentos da proposta (6.6) — elas têm anexos próprios, gerenciados aqui.