Consulta Completa
Relatório da base veicular: restrições, leilão, sinistro, débitos, gravame com agente financeiro e dados cadastrais. Proprietário atual quando disponível.
Resumo
| Item | Valor |
|---|---|
| Identificador técnico | consulta-completa |
| Dados exigidos | placa (no catálogo: placa) |
| O que devolve | JSON estruturado (por seção) + PDF |
| Preço vigente | R$ 38,99. 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-completa" \
-d '{"servico":"consulta-completa","placa":"ABC1D23","incluir_fipe":false}'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, risco e pdf_url. |
| erro | Valor estornado. erro_codigo diz o motivo e retryable se vale criar uma consulta nova. |
Campo dados
Estruturado por seção, no contrato da família da Consulta Completa.
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
- incluir_fipe: true embute a Tabela FIPE em dados.fipe e cobra o adicional informado em opcionais.incluir_fipe.preco_adicional (GET /v1/servicos). Se só a FIPE falhar, só essa parcela é estornada e dados.fipeErro diz o motivo.
- dados.debitos traz valores reais, estado por item e total_parcial. CONSTA_SEM_VALOR significa "deve, valor não informado": o total é um piso. debitos: null é "não verificado".
- As fotos de leilão não viajam no JSON: fotosLeilao traz índice e URL de cada uma, servidas por GET /v1/consultas/{id}/imagens/leilao/{indice}.
- risco é o mesmo índice exibido no painel e no laudo. Não é garantia de compra.
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.