Detrans (Consulta Unificada) - BETA

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

O que é

A consulta unificada dos Detrans retorna informações 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}

URL Base:

Parâmetros do header

Nome	Tipo	Obrigatório?	Descrição

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

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

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

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

Status 422

{
  "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 retornou aquele valor.

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

Resposta com erro

Todas as respostas de erro são as mesmas especificadas em cada Detran. Você pode verificar na lista de consultas o Detran que deseja, e lá está especificado os erros que podem retornar.