O que é#
Na consulta Detran PB - Consulta do Veículo você verifica informações e restrições de um veículo com placa registrada na Paraíba:
- informações como marca, modelo, categoria, cor, ano de fabricação
- se possui restrições como alienação, comunicado de venda
Sobre a requisição#
Método: POST
Endereço: https://api.plexi.com.br/api/maestro/detran-pb/veiculos/consulta-veiculo
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, com ou sem máscara |
| renavam | string | Sim | Renavam 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": "11111111-1111-1111-1111-111111111111"
}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
{
"ano": "2020/2020",
"categoria": "PARTICULAR",
"chassi": "99999999999999999",
"combustivel": "GASOLINA",
"cor": "CINZA",
"especieTipo": "PASSAGEIRO",
"marcaModelo": "HONDA/CG 150 FAN ESI",
"municipio": "NOME DO MUNICIPIO",
"financiamento": true,
"placa": "ABC-1234",
"renavam": "9999.999999-9",
"situacao": "VEICULO EM CIRCULACAO",
"totalBombeiro": 159.30,
"totalDebitos": 5438.4,
"totalDpvat": 1987.47,
"totalIpva": 318.03,
"totalLicenciamento": 2973.6,
"totalMultas": 0,
"ultimoLicenciamento": "2021"
}Resposta com erro
JSON
{
"status": "erro",
"mensagem": "Placa não cadastrada no sistema."
}
