Page Comparison

Note
ATENÇÃO: essa consulta se encontra em estágio beta, o que significa que podem podendo haver alterações . Além disso apenas nas assinaturas das APIs sem aviso prévio. No momento somente os Detrans de MG, SP, PR, RS, SC, BA estão implementados no momento.

O que éNa

A consulta unificada de dos Detrans você verifica retorna informações e a situação de um veículo através de apenas um endpoint e apenas um resultado. O resultado é mais resumido por isso é importe verificar se é adequado ao seu de todos os detrans em formato padrão de input e output. Nesta API, os resultados retornados para cada estado podem conter menos informações do que as APIs individuais por estado, portanto é importante verificar qual a melhor opção para o seu caso de uso.

Sobre a requisição:

Método: POST

Endereço: URL Base + /api/maestro/detran/{uf}

...

Include Page

	URL Base
	URL Base

Parâmetros do header

Nome	Tipo	Obrigatório?	Descrição
Authorization	String	Sim	Chave de API gerada no cadastro no Plexi, prefixada com `Bearer`
Callback	String	Não	URL para onde o resultado da requisição será enviado via HTTP POST.

Parâmetros da URL

Nome	Tipo	Obrigatório?	Descrição
uf	String	Sim	Sigla do estado que deseja consultar. EX: mg

Parâmetros do body

Os parâmetros são os mesmos utilizados na consulta original. Você pode verificar na lista de consultas o Detran que deseja, e lá está especificado os parâmetros de entrada.

Retornos possíveis da requisição

Status	Significado	Descrição	Informações retornadas
201	Created	Solicitação criada	Campo requestId, com o ID da requisição criada.
422	Unprocessable Entity	A solicitação contém erro	Em quais campos houve erro.

Exemplos de retornos

Status 201

Code Block
{ "requestId": "1fdd4247-4f98-4113-887a-b182117b0e42" }

...

Code Block
{ "message": "The given data was invalid.", "errors": { "cpf": [ "O campo cpf é obrigatório." ], "nome": [ "O campo name é obrigatório." ] } }

Resultados da pesquisa ( retornados no callback ou fazendo requisição à API de respostas )

Estrutura base de resposta

Todos os campos podem retornar null, quando um campo estiver com o valor null significa que aquele Detran não retorna aquela informação, qualquer valor diferente de null significa que o Detran retorno retornou aquele valor.

Code Block

language	json

{
  "detran": "pr",
  "placa": null"AAA-9999",
  "renavam": null"99999999999",
  "chassi": null"9AA999999AA999999",
  "nomeProprietario": null "E**** M****** D** S*****",
  "municipio": null"CAMBORIU",
  "anoFabricacao": null2000,
  "anoModelo": null2001,
  "marca": null"SCANIA",
  "modelo": null "T113 H 4X2 320(Nacional)",
  "cor": null"AZUL",
  "especie": null"Tracao",
  "tipoVeiculo": "CAMINHAO nullTRATOR",
  "categoria": null"Aluguel",
  "combustivel": null"Diesel",
  "licenciamento": {
    "ano": null2021,
    "situacao": "Veiculo licenciado digitalmente em: null19/01/2021"
  },
  "restricoes": [
    "BLOQ. RENAJUD - TRANSFERENCIA",
    "ALIENACAO FIDUCIARIA AGENTE: BANCO BRADESCO SA"
  ],
  "situacao": "EM nullCIRCULAÇÃO",
  "ipva": {
    "ultimoAnoPago": null2021,
    "situacao": null "NADA CONSTA - PAGO"
  },
  "multas": [
    {
      "descricao": null "CONDUZIR VEICULO COM EQUIP OBRIG EM DESAC COM ESTAB CONTRAN",
      "data": null"01/01/2021",
      "valor": null123.99
    }
  ],
  "infracoes": [
    {
      "descricao": null"CONDUZIR VEICULO COM EQUIP OBRIG EM DESAC COM ESTAB CONTRAN",
      "data": null"01/01/2021",
      "valor": null123.99
    }
  ],
  "pdf": "JVBERi0xLjQKMSAwIG9iago8..."

...

Versions Compared

Old Version 1

New Version Current

Key