O que é#
Consulta pública sobre informações de situações de veículos cadastrados no Detran do Rio Grande do Sul.
Sobre a requisição#
Método: POST
Endereço: https://api.plexi.com.br/api/maestro/detran-rs/veiculos/consulta-individual-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. |
| renavam | string | Sim | Renavam do veículo a ser pesquisado. |
Estrutura da resposta#
| 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 quando você faz a requisição#
Status 201
A consulta recebida com sucesso e será processada. Com o ID retornado você pode consultar se já houve resposta.
JSON
{
"requestId": "1fdd4247-4f98-4113-887a-b182117b0e42"
}Status 422
Significa que ocorreu um erro de validação dos dados enviados.
JSON
{
"message": "The given data was invalid.",
"errors": {
"cpf": [
"O campo cpf é obrigatório."
],
"nome": [
"O campo nome é obrigatório."
]
}
}Resultados da pesquisa (retornados no callback ou fazendo requisição à API de respostas)#
Resposta com registro encontrado
JSON
{
"marca": "FORD",
"modelo": "ECOSPORT FSL1.6FLEX",
"renavam": "99999999",
"placa": "AAA0000",
"municipio": "CIDADE EXEMPLO",
"tipo": "Camioneta",
"especie": "Misto",
"chassi": "9A9A99999AAAAA99990",
"situacao": "Em circulação",
"furtado": false,
"emDeposito": false,
"anoFabricacao": 2020,
"anoModelo": 2020,
"cpfProprietario": "99999999999",
"cor": "Preta",
"validadeUltimoLicenciamento": "01/01/2020",
"dataUltimoLicenciamento": "01/01/2020",
"ipva": [
{
"vencimento": "01/01/2020",
"valorOriginal": 932.38,
"exercicio": 2020,
"dividaAtiva": true,
"situacao": "Com DAT"
}
],
"infracoes": [
{
"orgaoAutuador": 999999,
"serie": "E99999999",
"dataHora": "01/01/2020 10:00",
"descricao": "TRANSITAR EM VELOCIDADE SUPERIOR À MÁXIMA PERMITIDA EM ATÉ 20%",
"valor": 130.16,
"local": "Rua Exemplo, 123 - Bairro Exemplo",
"pontuacao": 4,
"situacao": "A Vencer"
}
],
"licenciamento": {
"codigoSegurancaCrlv": null,
"descricaoDocumento": "CRLV",
"crlve": false,
"exercicio": 2020,
"fac": false,
"codigoRastreamentoSedex": "AA999999999BR",
"postadoCorreios": "01/01/2020",
"situacaoDocumento": "Documento entregue ao destinatário"
},
"restricoes": [
{
"descricao": "SNG - Alienação Fiduciária",
"campos": [
{
"nome": "Data do Contrato",
"valor": "01/01/2020"
}
]
}
],
"dpvat": [
{
"exercicio": "2020",
"valor": 5.23,
"situacao": "Seguro não pago"
},
{
"exercicio": "2019",
"valor": 16.21,
"situacao": "Seguro não pago"
}
],
"pdf": "{PDF EM BASE64}"
}Resposta com erro
Placa não encontrada:
JSON
{
"status": "erro",
"mensagem": "Nenhum veículo encontrado com os critérios informados."
}Renavam inválido:
JSON
{
"status": "erro",
"mensagem": "O Código RENAVAM informado não é deste veículo."
}Placa incorreta e renavam correto:
JSON
{
"status": "erro",
"mensagem": "A placa do veículo é: AAA0000. Informe esta placa para efetuar a consulta."
}
