Pular para o conteúdo
ZapCar
Developersv1

Imagens da Consulta Completa

Uma foto de leilão (ou, nas consultas antigas, uma imagem de vistoria ou do certificado CSV) por chamada.

GET/v1/consultas/{id}/imagens/{tipo}/{indice}
GratuitoDevolve arquivoSandbox

Baixa uma imagem da Consulta Completa (e dos laudos da mesma família). Você não monta essas URLs à mão: elas vêm prontas dentro de dados, e o indice é a posição no array correspondente.

Informação:

Por que a imagem não vem no JSON

Um retorno real da Consulta Completa passa de 8 MB quando as fotos viajam em base64. Elas ficam guardadas à parte e o JSON traz só o link de cada uma. A contagem já decide muita coisa: fotosLeilao com itens significa que o veículo passou por leilão, mesmo que leilao venha null.

A resposta é o binário, com o Content-Type real (image/png, image/jpeg ou application/pdf). Em serviços sem imagens, a resposta é 404 IMAGEM_NOT_FOUND; antes da conclusão, 400 PDF_NOT_READY; com a chave de teste, 422 SANDBOX_SEM_DOCUMENTO.

Pedido
curl -L "https://api.zapcarconsulta.com.br/v1/consultas/6f1c2e2a-1b3d-4a9e-8f7c-2a1b3c4d5e6f/imagens/leilao/0" \
  -H "Authorization: Bearer $ZAPCAR_API_KEY" \
  -o leilao_0.jpg
Resposta
HTTP/1.1 200 OK
Content-Type: image/jpeg
Content-Disposition: inline; filename="zapcar_ABC1D23_leilao_0.jpg"

…(binário)
Testar no API Explorer (sandbox)

Requisição

Parâmetros de caminho

idstring (uuid)obrigatório
Id da consulta (UUID), como devolvido pelo POST /v1/consultas.
tipostringobrigatório
O que a imagem é (não de onde veio).
Valores:leilaooutracsv-imagemcsv-pdf
indiceintegerobrigatório
Índice na lista, a partir de 0.

Cabeçalhos

Authorizationstringobrigatório
Sua chave no formato Bearer zc_live_… (produção) ou Bearer zc_test_… (teste). O cabeçalho X-API-Key também é aceito. Ver Autenticação.

Exemplo: Bearer zc_test_…

Respostas

  • 200
    Imagem ou PDF do certificado.Arquivo: image/jpeg, image/png, application/pdf
  • 400
    Pedido inválido. Nada foi criado nem cobrado. codigo diz o que corrigir.Corpo: ApiError
  • 401
    Chave ausente, inválida ou revogada.Corpo: ApiError
  • 404
    Não encontrado, ou não pertence a esta conta (um id de outro cliente responde 404, nunca o dado).Corpo: ApiError
  • 429
    Rate limit excedido. Respeite o header Retry-After (segundos) antes de repetir. Não consome saldo.Corpo: ApiError
  • 500
    Falha interna inesperada. É transitória (retryable: true); informe o request_id ao suporte se persistir.Corpo: ApiError

Cabeçalhos da resposta

RateLimit-Limitintegerpode não vir
Teto de requisições da janela de 60s (120 em produção; 60 com chave de teste, em contador separado).
RateLimit-Remainingintegerpode não vir
Requisições restantes na janela atual.
RateLimit-Resetintegerpode não vir
Segundos até a janela zerar.
X-Request-Idstring (uuid)pode não vir
Id de correlação desta requisição. Informe ao suporte para localizar a chamada nos logs.

Tipos de imagem

tipoO que éOnde está a URL
leilaoFoto do veículo em pátio de leilão. É prova de passagem por leilão.dados.fotosLeilao[].url
outraImagem de vistoria ou anúncio. Não indica leilão.dados.imagensOutras[].url
csv-imagemCertificado de Segurança Veicular, em imagem.dados.csv[].imagem_url
csv-pdfCertificado de Segurança Veicular, em PDF.dados.csv[].pdf_url
Atenção:

Desde 14/10/2026

A Consulta Completa continua trazendo as fotos de leilao, mas não traz mais imagens de vistoria/anúncio nem o certificado CSV em imagem: outra, csv-imagem e csv-pdf só existem nas Completas concluídas entre 27/08/2026 e 13/10/2026. Consultas concluídas antes de 27/08/2026 não têm imagens armazenadas.