View Source

O que é

Na consulta Detran MS - Consulta Débito de Veículos - você verifica informações e débitos de um veículo com placa registrada no Mato Grosso do Sul:

informações como marca, modelo, categoria, cor, ano de fabricação
se possui débitos ( licenciamento, IPVA ) ou multas

Sobre a requisição:

Método: POST

Endereço: URL Base + /api/maestro/detran-ms/veiculos/consulta-debito-veiculo

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 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.

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

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

Resposta com registro encontrado

{
	"placa": "AAA0000",
	"renavam": "AAA0000",
	"chassi": "000000000AV000000",
	"cor": "AZUL",
	"categoria": "PARTIC",	
	"motor": "999999999999999",
	"anoFabricacao": "2012",
	"anoModelo": "2013",
	"dataExpedicaoDocumento": "30/12/2015",
	"licenciamento": "VENCIDO",
	"marca": "FIAT",
	"modelo": "UNO MILLE WAY ECON",
	"cidade": "CAMPO GRANDE",
	"crlvDigital": "INDISPONÍVEL",
	"observacoes": [
		"VEICULO COM ALIENACAO FIDUCIARIA BANCO PAN S.A."
	],
	"debitos": [
	    {
	      	"descricao": "LIC.: 2016 2017 2018 2019 2020",
	      	"valor": 1104.05
	    },
	    {
	      	"descricao": "IPVA 2020 - VALOR ATE 01/09/20",
	      	"valor": 690.58
	    },
	    {
	      	"descricao": "SEGURO OBRIGATORIO 2019",
	      	"valor": 16.21
	    },
	    {
	      	"descricao": "SEGURO OBRIGATORIO 2020",
	      	"valor": 5.23
	    }
	],
	"totalGeralDebitos": 1816.07
}

Resposta com erro

Veículo não encontrado, placa ou renavam incorretos, veículo transferido:

{
  "status":"erro",
  "mensagem":"Veículo não cadastrado em MS"
}