Integração APIVeículosDébitos e Multas

Débitos e Multas

Esta API retorna dados veículos e todos os débitos e multas relacionados ao mesmo, incluindo o código de barras referente a cada débito e multa.

Montando a requisição

Método da requisição

GET

Endereço da requisição

Principal:

https://api.activethread.com.br/detran/v1/debts/AAA1B11

Secundário:

https://api.detran.app.br/detran/v1/debts/AAA1B11

Parâmetros da requisição

Via URL

  • https://api.detran.app.br/detran/v1/debts/AAA1B11?at=XPTO

Via Cabeçalho

  • Authorization: XPTO

Respostas da requisição

200 - Sucesso

Observação: Os dados abaixo são apenas demonstrativos, com a finalidade de mapeamento da estrutura. Por isso, de forma alguma representam a realidade.

{
  "status": "DONE",
  "result": {
    "placa": "AAA1B11",
    "placaAnterior": null,
    "chassi": "INFORMACAO OCULTADA",
    "chassiRemarcado": false,
    "motor": "INFORMACAO OCULTADA",
    "uf": "MG",
    "municipio": "IPATINGA",
    "renavam": "INFORMACAO OCULTADA",
    "tipoDocumentoFaturado": null,
    "numeroDocumentoFaturado": null,
    "ufFaturado": null,
    "anoFabricacao": 2008,
    "anoModelo": 2009,
    "cmt": null,
    "pbt": null,
    "restricoes": {
      "restricaoRenainf": false,
      "restricaoRenajud": false,
      "restricaoRfb": false,
      "restricaoRouboFurto": false,
      "ocorrencia": null,
      "recall": false,
      "sinistro": false,
      "restricao1": null,
      "restricao2": null,
      "restricao3": null,
      "restricao4": null
    },
    "debitos": [
      {
        "codigoBarra": "INFORMACAO OCULTADA",
        "linhaDigitavel": "INFORMACAO OCULTADA",
        "total": "269929",
        "subtotal": 0,
        "taxas": 0,
        "multa": 0,
        "dataVencimento": "2024-09-30T03:00:00.000Z",
        "identificador": null,
        "dataVencimentoOriginal": "2024-09-30T03:00:00.000Z",
        "descricao": "IPVA 01.002667712-95",
        "razaoIndisponibilidade": null,
        "idPagamento": "5d6fc346-b02e-4c0a-b195-68f6c8a4c0b3",
        "statusPagamento": "opened",
        "cota": 0,
        "tipo": 2,
        "dadosExtra": null
      },
      {
        "codigoBarra": "INFORMACAO OCULTADA",
        "linhaDigitavel": "INFORMACAO OCULTADA",
        "total": 41447,
        "subtotal": 32306,
        "taxas": 6461,
        "multa": 2680,
        "dataVencimento": "2024-09-20T03:00:00.000Z",
        "identificador": null,
        "dataVencimentoOriginal": "2024-01-19T03:00:00.000Z",
        "descricao": "IPVA 2024 - cota 1",
        "razaoIndisponibilidade": null,
        "idPagamento": "03d6c0b4-ef64-42b5-9134-ac759fd2f25c",
        "statusPagamento": "opened",
        "cota": 1,
        "tipo": 2,
        "dadosExtra": null
      },
      {
        "codigoBarra": "INFORMACAO OCULTADA",
        "linhaDigitavel": "INFORMACAO OCULTADA",
        "total": 41137,
        "subtotal": 32306,
        "taxas": 6461,
        "multa": 2370,
        "dataVencimento": "2024-09-20T03:00:00.000Z",
        "identificador": null,
        "dataVencimentoOriginal": "2024-02-23T03:00:00.000Z",
        "descricao": "IPVA 2024 - cota 2",
        "razaoIndisponibilidade": null,
        "idPagamento": "69042e00-f9c0-4de9-aed2-363549be0c7c",
        "statusPagamento": "opened",
        "cota": 2,
        "tipo": 2,
        "dadosExtra": null
      },
      {
        "codigoBarra": "INFORMACAO OCULTADA",
        "linhaDigitavel": "INFORMACAO OCULTADA",
        "total": 40815,
        "subtotal": 32306,
        "taxas": 6461,
        "multa": 2048,
        "dataVencimento": "2024-09-20T03:00:00.000Z",
        "identificador": null,
        "dataVencimentoOriginal": "2024-03-22T03:00:00.000Z",
        "descricao": "IPVA 2024 - cota 3",
        "razaoIndisponibilidade": null,
        "idPagamento": "1f2e4e2a-685b-4a4a-9a10-86342e60eca9",
        "statusPagamento": "opened",
        "cota": 3,
        "tipo": 2,
        "dadosExtra": null
      },
      {
        "codigoBarra": "INFORMACAO OCULTADA",
        "linhaDigitavel": "INFORMACAO OCULTADA",
        "total": 4601,
        "subtotal": 3936,
        "taxas": 472,
        "multa": 193,
        "dataVencimento": "2024-09-20T03:00:00.000Z",
        "identificador": null,
        "dataVencimentoOriginal": "2024-04-01T03:00:00.000Z",
        "descricao": "Licenciamento 2024",
        "razaoIndisponibilidade": null,
        "idPagamento": "871b8c90-3ccf-45dd-9ab8-40f95a343f5d",
        "statusPagamento": "opened",
        "cota": 0,
        "tipo": 1,
        "dadosExtra": null
      }
    ],
    "gravame": null,
    "situacao": "EM CIRCULAÇÃO",
    "marcaModelo": "I/VW BORA",
    "codigoMarcaModelo": null,
    "grupo": null,
    "tipoVeiculo": "AUTOMOVEL",
    "especie": "PASSAGEIRO",
    "cor": "PRATA",
    "combustivel": "GASOLINA",
    "categoria": "PARTICULAR",
    "origem": "ESTRANGEIRO",
    "potencia": 116,
    "cilindradas": 1984,
    "eixos": 2,
    "capacidadePassageiros": 5,
    "ultimoLicenciamento": 2016,
    "indicadorAtivo": null,
    "nomeProprietario": "INFORMACAO OCULTADA",
    "numeroDocumentoProprietario": "INFORMACAO OCULTADA",
    "tipoDocumentoProprietario": "CPF",
    "instituicaoAlienacao": null,
    "documentoInstituicaoAlienacao": null,
    "situcaoLicenciamento": null,
    "licenciadoAte": null,
    "proprietario": {
      "nome": "INFORMACAO OCULTADA",
      "mae": "INFORMACAO OCULTADA",
      "pai": null,
      "situacao": null,
      "tamanho": null,
      "abertura": null,
      "codigoNaturezaJuridica": null,
      "descricaoNaturezaJuridica": null,
      "capitalSocial": null,
      "nomeLegal": "INFORMACAO OCULTADA",
      "documento": "INFORMACAO OCULTADA",
      "dataNascimento": "1980-04-04T03:00:00.000Z",
      "aniversario": "1980-04-04",
      "contatos": {
        "telefones": [
          "INFORMACAO OCULTADA",
          "INFORMACAO OCULTADA",
          "INFORMACAO OCULTADA",
          "INFORMACAO OCULTADA",
          "INFORMACAO OCULTADA"
        ],
        "emails": ["[email protected]"]
      },
      "enderecos": [
        {
          "logradouro": "INFORMACAO OCULTADA",
          "numero": "150",
          "bairro": "IDEAL",
          "cep": "INFORMACAO OCULTADA",
          "estado": "MG",
          "cidade": "IPATINGA"
        },
        {
          "logradouro": "INFORMACAO OCULTADA",
          "numero": "6",
          "bairro": "CENTRO",
          "cep": "INFORMACAO OCULTADA",
          "estado": "MG",
          "cidade": "IPATINGA"
        },
        {
          "logradouro": "INFORMACAO OCULTADA",
          "numero": "636",
          "bairro": "IDEAL",
          "cep": "INFORMACAO OCULTADA",
          "estado": "MG",
          "cidade": "IPATINGA"
        }
      ]
    }
  }
}

400 - Requisição inválida

Exemplo:

{
  "message": "Por favor, informe uma placa válida."
}

401 - Não autorizado

{
  "message": "Não autorizado."
}

403 - Acesso negado

{
  "message": "Acesso negado!"
}

Exemplos da requisição - Autenticação via URL

HTTP

GET /detran/v1/debts/AAA1B11 HTTP/1.1
Host: api.activethread.com.br

cURL

curl --location 'https://api.activethread.com.br/detran/v1/debts/AAA1B11

JavaScript

const requestOptions = {
  method: "GET",
  redirect: "follow",
};
 
fetch(
  "https://api.activethread.com.br/detran/v1/debts/AAA1B11?at=XPTO",
  requestOptions
)
  .then((response) => response.text())
  .then((result) => console.log(result))
  .catch((error) => console.error(error));

NodeJs

const axios = require("axios");
 
let config = {
  method: "get",
  maxBodyLength: Infinity,
  url: "https://api.activethread.com.br/detran/v1/debts/AAA1B11?at=XPTO",
  headers: {},
};
 
axios
  .request(config)
  .then((response) => {
    console.log(JSON.stringify(response.data));
  })
  .catch((error) => {
    console.log(error);
  });

PHP

<?php
 
$curl = curl_init();
 
curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://api.activethread.com.br/detran/v1/debts/AAA1B11?at=XPTO',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => '',
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => 'GET',
));
 
$response = curl_exec($curl);
 
curl_close($curl);
echo $response;

Java

Unirest.setTimeouts(0, 0);
HttpResponse<String> response = Unirest.get("https://api.activethread.com.br/detran/v1/debts/AAA1B11?at=XPTO")
  .asString();

Python

import requests
 
url = "https://api.activethread.com.br/detran/v1/debts/AAA1B11?at=XPTO"
 
payload = {}
headers = {}
 
response = requests.request("GET", url, headers=headers, data=payload)
 
print(response.text)

Exemplos da requisição - Autenticação via Cabeçalho

HTTP

GET /detran/v1/debts/AAA1B11 HTTP/1.1
Host: api.activethread.com.br
Authorization: XPTO

cURL

curl --location 'https://api.activethread.com.br/detran/v1/debts/AAA1B11' \
--header 'Authorization: XPTO'

JavaScript

const myHeaders = new Headers();
myHeaders.append("Authorization", "XPTO");
 
const requestOptions = {
  method: "GET",
  headers: myHeaders,
  redirect: "follow",
};
 
fetch("https://api.activethread.com.br/detran/v1/debts/AAA1B11", requestOptions)
  .then((response) => response.text())
  .then((result) => console.log(result))
  .catch((error) => console.error(error));

NodeJs

const axios = require("axios");
 
let config = {
  method: "get",
  maxBodyLength: Infinity,
  url: "https://api.activethread.com.br/detran/v1/debts/AAA1B11",
  headers: {
    Authorization: "XPTO",
  },
};
 
axios
  .request(config)
  .then((response) => {
    console.log(JSON.stringify(response.data));
  })
  .catch((error) => {
    console.log(error);
  });

PHP

<?php
 
$curl = curl_init();
 
curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://api.activethread.com.br/detran/v1/debts/AAA1B11',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => '',
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => 'GET',
  CURLOPT_HTTPHEADER => array(
    'Authorization: XPTO'
  ),
));
 
$response = curl_exec($curl);
 
curl_close($curl);
echo $response;

Java

Unirest.setTimeouts(0, 0);
HttpResponse<String> response = Unirest.get("https://api.activethread.com.br/detran/v1/debts/AAA1B11")
  .header("Authorization", "XPTO")
  .asString();

Python

import requests
 
url = "https://api.activethread.com.br/detran/v1/debts/AAA1B11"
 
payload = {}
headers = {
  'Authorization': 'XPTO'
}
 
response = requests.request("GET", url, headers=headers, data=payload)
 
print(response.text)