O que é#

Na consulta Detran PE - Consulta de Placa você verifica informações e a situação de um veículo com placa registrada em Pernambuco.

Sobre a requisição#

Método: POST

Endereço: https://api.plexi.com.br/api/maestro/detran-pe/veiculos/consulta-placa

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 do body#

Nome Tipo Obrigatório? Descrição
placa string Sim Placa do veículo a ser pesquisado.
renavam string Sim Renavam do veículo a ser pesquisado.
chassi string Sim Chassi do veículo a ser pesquisado.

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

JSON
{
  "requestId": "00000000-0000-0000-0000-000000000000"
}

Status 422

JSON
{
  "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 )#

Resposta com registro encontrado

JSON
{
    "placa": "ABC1234",
    "veiculo": "",
    "debitos": {
        "IPVA": "SIM",
        "Licenciamento": "SIM",
        "Multas": "SIM",
        "DPVAT": "NADA CONSTA",
        "Autuações em Tramitação": "SIM"
    },
    "restricoes": [
        "SIM"
    ],
    "gravame": "NADA CONSTA"
}
JSON
{
    "placa": "ABC1234",
    "veiculo": "",
    "debitos": {
        "IPVA": "NADA CONSTA",
        "Licenciamento": "NADA CONSTA",
        "Multas": "NADA CONSTA",
        "DPVAT": "NADA CONSTA",
        "Autuações em Tramitação": "NADA CONSTA"
    },
    "restricoes": [
        "NADA CONSTA"
    ],
    "gravame": "NADA CONSTA"
}

Resposta com erro

Dados incorretos:

JSON
{
  "status":"erro",
  "mensagem":"Veículo não pertence a PE e sem débitos a pagar!",
  "pdf": "JVBERi=..."
}