Informações do veículo por placa
A consulta de veículos por placa da Creditas tem como objetivo principal melhorar a usabilidade da nossa API, oferecendo aos parceiros um recurso para simplificar suas operações e obter informações mais precisas sobre a garantia dos veículos.
Ao utilizar essa funcionalidade, os parceiros podem oferecer uma experiência mais fluida, minimizando a necessidade de inserção manual de dados e contando com informações mais assertivas do veículo para embasar suas decisões.
Além disso, a consulta de dados dos veículos por placa agiliza o processo de análise de crédito, proporcionando uma melhor experiência para o cliente e uma tomada de decisão mais rápida e eficiente.
Indicação de uso
Com o objetivo de tornar a experiência o mais fluida possível e otimizar os custos envolvidos no processo, a consulta da placa deve ser realizada após o resultado da simulação e da consulta de elegibilidade, conforme pode ser visto na imagem abaixo.
Ao passar pelo processo de simulação de um empréstimo, o usuário já demonstrou interesse na proposta e está buscando informações relevantes para sua tomada de decisão. Nesse momento, ele está engajado e disposto a fornecer dados adicionais que possam contribuir para uma análise mais precisa e personalizada.
Implementação da consulta de dados do veículo por placa
Para ter acesso ao recurso, é necessário estar devidamente autenticado com seu token da API.
Requisição HTTP GET
Tipo da Requisição | URL | Exemplo |
---|---|---|
GET | {{url_base}}vehicles/license-plate/{licensePlate} | https://stg-api.creditas.io/b2b/vehicles/license-plate/AAA0000 |
Request Path Param
Campo | Tipo | Obrigatório | Descrição |
---|---|---|---|
licensePlate | string | Sim | Placa do veículo: Ex.: ABC1324 ou ABC1D23 |
A placa precisa estar no formato brasileiro antigo ou no padrão Mercosul. Em ambos os casos, a placa é formada por sete caracteres alfanuméricos (apenas letras e números).
Exemplo de Request e Response
curl --location --request GET '{{url_base}}/vehicles/license-plate/AAA0000' \
--header 'Accept: application/vnd.creditas.v1+json' \
--header 'Content-Type: application/json;charset=UTF-8' \
--header 'Authorization: Bearer {{your_access_token}}'
{
"brand": "FIAT",
"model": "STRADA WORKING",
"manufacturingYear": 2014,
"modelYear": 2015,
"versions": [
{
"modelVersion": "FIAT/STRADA CS WORKING 1.4 8V Completo 2p Eta./Gas.",
"pricingDetail": {
"type": "MOLICAR",
"code": "01503150-0",
"value": 48152.0
}
},
{
"modelVersion": "FIAT/STRADA CS WORKING(Celebration6) Basico 2p Eta./Gas.",
"pricingDetail": {
"type": "MOLICAR",
"code": "01503151-2",
"value": 49078.0
}
},
]
}
Descrição dos campos da Response
Campo | Tipo | Obrigatório | Descrição |
---|---|---|---|
brand | string | Sim | Nome da marca do veículo. Ex.: FIAT |
model | string | Sim | Nome do modelo do veículo. Ex.: STRADA WORKING |
manufacturingYear | integer | Sim | Ano de fabricação do veículo. Ex.: 2014 |
modelYear | integer | Sim | Ano modelo do veículo. Ex.: 2015 |
versions | object array | Sim | Lista de possíveis .versões do veículo |
versions[*].versions | string | Sim | Nome completo da versão do veículo. Ex.: FIAT/STRADA CS WORKING(Celebration6) Basico 2p Eta./Gas. |
versions[*].pricingDetail.type | string | Sim | Tabela de precificação utilizada para listagem das versões (MOLICAR, FIPE, etc.). Ex.: MOLICAR |
versions[*].pricingDetail.code | string | Sim | Código identificador da versão na tabela de precificação utilizada. Ex.: 01503151-2 |
versions[*].pricingDetail.value | double | Sim | Valor médio do veículo de acordo com a tabela de precificação utilizada. Ex.: 48152.0 |
A precificação de um automóvel pode ser feita com base em diferentes tabelas de referência¹, as mais conhecidas são a Tabela Fipe e a Tabela Molicar.
¹Dependendo do nível de detalhamento da tabela de referência em relação aos itens opcionais de fábrica - como pacote de acessórios, ar-condicionado e transmissão automática - para um mesmo modelo (
model
) podem existir uma ou mais versões (modelVersion
) com diferentes precificações.Nesses casos, as versões (
modelVersion
) correspondem às diferentes configurações que um modelo pode apresentar. Caso a Tabela utilizada não leve em consideração esses itens, provavelmente, cada modelo terá apenas uma versão. É por isso que o atributo de versions pode trazer uma lista com 1 ou N elementos.
Cenários de erro na consulta
400 BAD REQUEST
Acontecem quando a placa informada não está no formato adequado (possui mais ou menos que 7 caracteres, padrão não segue o formato antigo brasileiro ou o novo formato Mercosul, etc.)
{
"code": "REQUEST_VALIDATION_ERROR",
"message": "Some fields are invalid",
"details": [
{
"target": "getVehicleVersionsByLicensePlate.licensePlate",
"message": "Must be a Mercosul format license plate with only letters and numbers"
}
]
}
409 CONFLICT
Acontecem quando o veículo consultado não está de acordo com a política da Creditas (ex.: idade acima de 15 anos).
{
"code": "CONFLICT",
"message": "Invalid manufacturingYear. The vehicle should have 15 or less years",
"details": []
}
Enviando os dados consultados na criação de uma nova proposta
Além de informações que já eram enviadas no collateral anteriormente, será necessário acrescentar no payload de criação de propostas outros dados fornecidos na consulta.
São eles:
- A tabela de precificação que está sendo utilizada;
- O código presente na versão do veículo que foi selecionado do payload de resposta da consulta de placa;
Ambas informações deverão ser enviadas em um objeto de pricingDetail
dentro do objeto collateral
. Exemplo:
{
"productType": "AUTO_REFI",
"purpose": "OTHERS",
"borrower": {...},
"conditions": {...},
"intendedCredit": {...},
"collateral": {
"value": 48152.0,
"debt": 0,
"brand": "FIAT",
"model": "STRADA WORKING",
"modelYear": 2015,
"manufacturingYear": 2014,
"modelVersion": "FIAT/STRADA CS WORKING 1.4 8V Completo 2p Eta./Gas.",
"borrowerVehicleOwner": true,
"licensePlate": "ABC1234",
"pricingDetail": {
"type": "MOLICAR",
"code": "01503150-0"
}
}
}
Updated 12 days ago