---
title: "Solicitação De Consulta"
method: POST
path: "/vehicle/debts/"
tags: ["Consulta de Débitos Veiculares"]
---

# Solicitação De Consulta

`POST /vehicle/debts/`

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](#tag/Webhook).
>
>
> [Neste link](https://docs-b2b.usezapay.com.br/docs/webhooks) 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](https://docs-b2b.usezapay.com.br/docs/consulta-de-debitos#consultando-os-d%C3%A9bitos-de-um-ve%C3%ADculo), 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](https://docs-b2b.usezapay.com.br/docs/consulta-de-debitos#massa-de-testes).

## Request body

- V2PackagesEnterpriseSchemasVehicleDebtSearchSchemaVehicleDebtSearchDTO
  - `license_plate` string, required — Placa do veículo em formato alfanumérico
  - `uf` string, nullable — Sigla do estado em que o veículo encontra-se emplacado. Ex: SP
  - `renavam` string, nullable — Renavam do veículo, é um número contendo até 11 dígitos
  - `chassis` string, nullable — Chassí do veículo
  - `request_id` string, nullable — Còdigo de uma solicitação de pesquisa anterior, informe quando a pesquisa original resultou na solicitação de dados adicionais
  - `customer` VehicleDebtCustomerDTO
    - `email` string, email, nullable
    - `phone` string, nullable
    - `document` string, nullable
    - `name` string, nullable
  - `extra_data` VehicleDebtSearchExtraDataDTO
    - `custom_field1` union — Campo de uso livre, com diferentes funções a depender do parceiro
      - string
      - object
    - `custom_data` VehicleDebtSearchExtraDataCustomDataDTO
      - `dealership` string, nullable — Concessionária
      - `dealership_document` string, nullable — CNPJ da concessionária
      - `customer_score` string, nullable — Score do cliente
      - `customer_age` string, nullable — Idade do cliente
      - `seller_age` string, nullable — Idade do vendedor
      - `active_customer` string, nullable — Flag para indicar se cliente está ativo
      - `defaulting_customer` string, nullable — Flag para indicar se cliente está inadimplente
    - `issue_ecrlv` boolean
    - `affiliates_params` VehicleDebtSearchExtraDataAffiliatesDataDTO
      - `coupon` string, nullable
      - `gclid` string, nullable
      - `utm_source` string, nullable
      - `utm_medium` string, nullable
      - `utm_keyword` string, nullable
      - `utm_campaign` string, nullable
  - `store_id` integer, nullable — ID do estabelecimento

## Response `201`

Sucesso

- VehicleDebtSearchResponse
  - `request_id` string, required

## Other responses

- `401` — Unauthorized
- `422` — Validation Error
- `503` — Serviço temporariamente indisponível

---

[API](https://skmtc.net/usezapay/apis/zapi.md) · [All operations](https://skmtc.net/usezapay/apis/zapi/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/usezapay/zapi/versions/50c96157fff4/schema)