Consultar Débitos Veiculares
curl --request POST \
--url https://api.uvvipague.com.br/uvvi/v1/debts \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"state": "DF",
"licensePlate": "JFI8753",
"renavam": "56387604559",
"cpfCnpj": "11111111111",
"externalId": "550e8400-e29b-41d4-a716-446655440000"
}
'import requests
url = "https://api.uvvipague.com.br/uvvi/v1/debts"
payload = {
"state": "DF",
"licensePlate": "JFI8753",
"renavam": "56387604559",
"cpfCnpj": "11111111111",
"externalId": "550e8400-e29b-41d4-a716-446655440000"
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
state: 'DF',
licensePlate: 'JFI8753',
renavam: '56387604559',
cpfCnpj: '11111111111',
externalId: '550e8400-e29b-41d4-a716-446655440000'
})
};
fetch('https://api.uvvipague.com.br/uvvi/v1/debts', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.uvvipague.com.br/uvvi/v1/debts",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'state' => 'DF',
'licensePlate' => 'JFI8753',
'renavam' => '56387604559',
'cpfCnpj' => '11111111111',
'externalId' => '550e8400-e29b-41d4-a716-446655440000'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.uvvipague.com.br/uvvi/v1/debts"
payload := strings.NewReader("{\n \"state\": \"DF\",\n \"licensePlate\": \"JFI8753\",\n \"renavam\": \"56387604559\",\n \"cpfCnpj\": \"11111111111\",\n \"externalId\": \"550e8400-e29b-41d4-a716-446655440000\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.uvvipague.com.br/uvvi/v1/debts")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"state\": \"DF\",\n \"licensePlate\": \"JFI8753\",\n \"renavam\": \"56387604559\",\n \"cpfCnpj\": \"11111111111\",\n \"externalId\": \"550e8400-e29b-41d4-a716-446655440000\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.uvvipague.com.br/uvvi/v1/debts")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"state\": \"DF\",\n \"licensePlate\": \"JFI8753\",\n \"renavam\": \"56387604559\",\n \"cpfCnpj\": \"11111111111\",\n \"externalId\": \"550e8400-e29b-41d4-a716-446655440000\"\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"message": "Consulta de débitos iniciada com sucesso",
"requestId": "req_abc123xyz",
"externalId": "550e8400-e29b-41d4-a716-446655440000",
"status": "PROCESSING"
}{
"success": false,
"error": {
"code": "INVALID_REQUEST",
"message": "Parâmetros inválidos na requisição",
"details": {}
}
}Débitos
Consultar Débitos
Consulta débitos pendentes de um veículo (multas, IPVA, licenciamento, taxas). Processamento assíncrono com retorno via webhook.
POST
/
uvvi
/
v1
/
debts
Consultar Débitos Veiculares
curl --request POST \
--url https://api.uvvipague.com.br/uvvi/v1/debts \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"state": "DF",
"licensePlate": "JFI8753",
"renavam": "56387604559",
"cpfCnpj": "11111111111",
"externalId": "550e8400-e29b-41d4-a716-446655440000"
}
'import requests
url = "https://api.uvvipague.com.br/uvvi/v1/debts"
payload = {
"state": "DF",
"licensePlate": "JFI8753",
"renavam": "56387604559",
"cpfCnpj": "11111111111",
"externalId": "550e8400-e29b-41d4-a716-446655440000"
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
state: 'DF',
licensePlate: 'JFI8753',
renavam: '56387604559',
cpfCnpj: '11111111111',
externalId: '550e8400-e29b-41d4-a716-446655440000'
})
};
fetch('https://api.uvvipague.com.br/uvvi/v1/debts', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.uvvipague.com.br/uvvi/v1/debts",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'state' => 'DF',
'licensePlate' => 'JFI8753',
'renavam' => '56387604559',
'cpfCnpj' => '11111111111',
'externalId' => '550e8400-e29b-41d4-a716-446655440000'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.uvvipague.com.br/uvvi/v1/debts"
payload := strings.NewReader("{\n \"state\": \"DF\",\n \"licensePlate\": \"JFI8753\",\n \"renavam\": \"56387604559\",\n \"cpfCnpj\": \"11111111111\",\n \"externalId\": \"550e8400-e29b-41d4-a716-446655440000\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.uvvipague.com.br/uvvi/v1/debts")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"state\": \"DF\",\n \"licensePlate\": \"JFI8753\",\n \"renavam\": \"56387604559\",\n \"cpfCnpj\": \"11111111111\",\n \"externalId\": \"550e8400-e29b-41d4-a716-446655440000\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.uvvipague.com.br/uvvi/v1/debts")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"state\": \"DF\",\n \"licensePlate\": \"JFI8753\",\n \"renavam\": \"56387604559\",\n \"cpfCnpj\": \"11111111111\",\n \"externalId\": \"550e8400-e29b-41d4-a716-446655440000\"\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"message": "Consulta de débitos iniciada com sucesso",
"requestId": "req_abc123xyz",
"externalId": "550e8400-e29b-41d4-a716-446655440000",
"status": "PROCESSING"
}{
"success": false,
"error": {
"code": "INVALID_REQUEST",
"message": "Parâmetros inválidos na requisição",
"details": {}
}
}Descrição
Consulta débitos pendentes de um veículo incluindo multas, IPVA, licenciamento e taxas diversas.Este endpoint processa a consulta de forma assíncrona. Os resultados serão enviados via webhook quando a consulta for concluída.
Fluxo de Processamento
- Envie a requisição com os dados do veículo
- Receba confirmação imediata de que a consulta foi iniciada
- Aguarde o processamento (geralmente 10-30 segundos)
- Receba os resultados via webhook configurado
Campo externalId
O campo
externalId é altamente recomendado. Use um UUID único para rastrear a consulta e correlacionar com os webhooks recebidos.Códigos de Resposta HTTP
200 - Sucesso
Consulta iniciada com sucesso. Aguarde o webhook com os resultados.{
"message": "Consulta iniciada com sucesso",
"transactionId": 817210768,
"externalId": "550e8400-e29b-41d4-a716-446655440000",
"status": "PROCESSING"
}
400 - Bad Request
Dados inválidos na requisição:- Placa inválida
- RENAVAM inválido
- CPF/CNPJ inválido
- Estado (UF) inválido
422 - Unprocessable Entity
Dados válidos mas não podem ser processados:- Veículo não encontrado
- Estado temporariamente indisponível
Tipos de Resposta via Webhook
Após o processamento, você receberá um webhook com um dos seguintes tipos:- debts: Veículo possui débitos pendentes
- VehicleWithoutDebts: Veículo sem débitos
- VehicleNotFound: Veículo não encontrado
- search-error-event: Erro na consulta (indisponibilidade do Detran)
Consulte a documentação de ENUMs para detalhes sobre cada tipo.
Próximos Passos
Após receber os débitos via webhook, você pode:- Simular parcelas com
/uvvi/v1/installments - Criar um checkout com
/uvvi/v1/checkout - Processar o pagamento com
/uvvi/v1/payment
Authorizations
API Key fornecida no painel administrativo da Uvvipague
Body
application/json
Sigla do estado (UF)
Example:
"DF"
Placa do veículo
Example:
"JFI8753"
Número do RENAVAM (11 dígitos)
Example:
"56387604559"
CPF ou CNPJ do proprietário (apenas números)
Example:
"11111111111"
Identificador único (UUID) para rastreamento
Example:
"550e8400-e29b-41d4-a716-446655440000"
Response
Consulta iniciada com sucesso. Resultados serão enviados via webhook.