v1
latestOpenAPI 3.1.02026-07-2678221359.6 KBSolicitação De Consulta
A API de consulta de débitos veiculares permite que o cliente consulte os débitos de um veículo a partir de um fluxo assíncrono.
Antes de realizar uma consulta, você deverá cadastrar uma URL para receber as atualizações de status da pesquisa via webhook através deste endpoint.
Neste link você poderá encontrar um guia com maiores detalhes de como cadastrar um endpoint webhook para receber os resultados da sua pesquisa.
Ao realizar a requisição com sucesso, você receberá um código através do campo request_id. Segundos depois, você receberá um webhook com o resultado da pesquisa e poderá usar esse código como rastreio.
Eventos de Pesquisa de Débitos Veiculares que poderão ser enviados via webhook
| Evento | Descrição |
|---|---|
| vehicle_debts_found | Foram encontrados débitos para o veículo pesquisado. |
| vehicle_debt_not_found | Não foram encontrados débitos para o veículo pesquisado. |
| vehicle_not_found | O veículo informado não foi encotrado. |
| vehicle_debt_search_error | Houve algum erro ao tentar realizar a pesquisa de débitos do veículo (Detalhes serão informados no corpo do evento) |
| vehicle_enriched_partially | A pesquisa não foi concluída porque não foi possível encontrar dados adicionais do veículo. |
Em nosso guia de uso, você poderá encontrar exemplos de payloads que seu endpoint receberá de acordo com cada um dos eventos listados acima.
Para testar o comportamento dessa API e diferentes tipos de retorno em ambiente sandbox, separamos um conjunto de placas de testes para você neste link.
Request body
Response
Sucesso
Example response
{
"request_id": "653bde82b520d9659513988b"
}