Solicitar Relatório / Histórico
Registra solicitação de geração de relatório / histórico de um veículo.
Este endpoint retorna um protocolo único, que pode ser utilizado para realizar consultas detalhadas no endpoint /v2/consultarProtocolo. A partir desse protocolo, você poderá obter os dados da consulta no formato JSON para manipulação em seu sistema ou diretamente em PDF, pronto para download e compartilhamento.
PDF também podem ser gerado já com identidade visual da sua marca (cor, logo e seu site). para isso necessário previamente se habilitar como revendedor junto a nossa equipe.
POST https://api.consultarplaca.com.br/v2/solicitarRelatorio
Request Body
placa
string
Placa do Veículo. Placa deve possuir os seguintes formatos: AAA9999 ou AAA9A99
tipo_consulta
string
Tipo da consulta. Valores possíveis: - bronze - prata - ouro - diamante - personalizada Para opção personalizada o campo informacoes_adicionais é obrigatório.
url_notificacao
string
URL para onde será enviado a notificação quando a consulta estiver pronta. Quando enviado este parâmetro assim que finalizado o processamento do relatório uma notificação POST será enviada com um formato JSON conforme exemplo abaixo:
{
"protocolo":"ABCDEF",
"dados":{
"url_pdf":"http://app.consultarpla...."
}
}
consulta_para_revenda
boolean
Identificação se o relatório deve ou não ser gerado no formato de revenda. 1 para SIM. Neste caso o relatório será gerado com a logo, cor e endereço do site do revendedor. 0 para NÃO. Neste caso o relatório é gerado com a identidade visual do Consultar Placa. O valor padrão deste campo é 0 (NÃO). * Para gerar relatório como revenda é necessário credenciar sua conta junto a nossa equipe.
informacoes_adicionais
String
Informações adicionais que devem ser inclusas no relatório. Para mais de um adicional passar os valores separados por vírgula. (Ex: 3, 4, 1). Valores Possíveis: 1 = Informações sobre a ocorrência de sinistros com Perda Total (PT)
3 = Registro de Ofertas em Leilões PRIME (Verifica leilões Corporativo, Privado e Varejo ) 4 = Histórico de Roubo e Furto
5 = Verificação junto a Base Federal (DENATRAN) sobre Restrições Financeiras e Judiciais (RENAJUD)
7 = Verificação junto a Base Estadual (DETRANS) como Renavam e Restrições)
8 = Informações gerais sobre o veículo (Chassi, Marca/Modelo, Ano Modelo ...)
12 = Referência de Preço (Fipe / Precificador)
13 = Registro de Ofertas em Leilões Simples (NÃO verifica Leilões Corporativo, Privado e Varejo ) 17 = Verificação junto ao Registro Nacional de Infrações de Trânsito (RENAINF)
18 = Recall
19 = Guia de Imagens (NÃO necessariamente imagens do veículo consultado)
23 = Ficha Técnica Comparativa 24 = Custo Médio de Manutenção 25 = Proprietário atual do veículo (Exibe apenas o primeiro nome e os dígitos iniciais do documento, sem identificar a pessoa).
Caso seja enviado algum adicional inválido, ou que já esteja contido no tipo de consulta solicitado o mesmo será ignorado.
Exemplos de respostas
200 - Consulta solicitada com sucesso
Atualizado