Consulta Simples
Dados cadastrais, gravame, RENAJUD, roubo/furto e veículo baixado; débitos quando a base informa.
Resumo
| Item | Valor |
|---|---|
| Identificador técnico | consulta |
| Dados exigidos | placa (no catálogo: placa) |
| O que devolve | JSON do veículo + PDF |
| Preço vigente | R$ 5,98. Com a sua chave, GET /v1/servicos traz o seu preço. |
| Prazo | A maioria das consultas fica pronta em poucos minutos; a base estadual pode levar cerca de 2 minutos na primeira consulta da placa no dia. |
| Bloco veiculo | Sim (contrato normalizado da ZapCar) |
Requisição
Pelo endpoint comum de consultas, POST /v1/consultas. Os valores do exemplo são fictícios.
curl -X POST "https://api.zapcarconsulta.com.br/v1/consultas" \
-H "Authorization: Bearer $ZAPCAR_API_KEY" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: pedido-erp-984281-consulta" \
-d '{"servico":"consulta","placa":"ABC1D23"}'Resposta
O POST devolve 201 com o id e status: "processando". O resultado sai em GET /v1/consultas/{id}, que passa por um destes estados:
| status | O que vem |
|---|---|
| processando | Só o envelope. Consulte de novo em 3 a 5 s. |
| concluido | dados, veiculo e pdf_url. |
| erro | Valor estornado. erro_codigo diz o motivo e retryable se vale criar uma consulta nova. |
Campo dados
No formato da base consultada (camada de espelho): nomes e preenchimento acompanham a fonte. Para dado com forma garantida, use o bloco veiculo quando o serviço tiver.
veiculo é o mesmo em todos os serviços que o têm. Ver o exemplo completo em Resultados e os campos no dicionário.Particularidades
- A base estadual pode levar cerca de 2 minutos numa placa consultada pela primeira vez no dia. A mesma placa, repetida, volta mais rápido.
- nao_verificado lista as categorias que a base não checou nesta consulta. Campo vazio que aparece nessa lista é "não verificado", nunca "nada consta".
- O documento do proprietário vem de uma segunda base: quando ela não libera o dado, proprietario_s_.documento vem "" e proprietario.documento vem null, com o nome preenchido.
- O PDF é desenhado pela ZapCar no layout do laudo da base, a partir do mesmo dados. Item não respondido sai como NÃO INFORMADO.
No sandbox
Cenário escolhido pela placa (TST0001 limpo, TST0002 gravame, TST0003 RENAJUD, TST0004 débitos, TST0005 sinistro e leilão, TST0404 não encontrado, TST0503 falha retentável, TST9999 nunca conclui). Bloco veiculo fiel ao contrato; dados reduzido e marcado com _sandbox.
Cobrança
Debitado no POST, antes do processamento, e estornado automaticamente se a consulta terminar em erro. Pedido recusado na validação (400, 402, 409, 422) não cobra. Ler o resultado e baixar o documento são gratuitos. Ver Cobrança e estorno.
Testar no sandbox: abrir no API Explorer. Base da API: https://api.zapcarconsulta.com.br.