> ## Documentation Index
> Fetch the complete documentation index at: https://developers.uvvipague.com.br/llms.txt
> Use this file to discover all available pages before exploring further.

# Bem-vindo à Uvvipague API

> Plataforma completa para consulta e pagamento de débitos veiculares em todo o Brasil

## Uvvipague API - Débito Veicular

<img height="auto" src="https://pub-7628d64e44ea4b73adec19e9040b3c69.r2.dev/images/Captura%20de%20Tela%202025-12-12%20a%CC%80s%2018.03.48.png" />

A **API de Débito Veicular da Uvvipague** é a solução mais completa para integração com sistemas de consulta e pagamento de débitos veiculares no Brasil. Com uma única integração, você acessa todos os 26 estados brasileiros e o Distrito Federal.

<Info>
  **Integração Única**: Consulte e pague débitos de todos os Detrans do Brasil através de uma única API, sem necessidade de múltiplas integrações.
</Info>

### O que você pode fazer

<CardGroup cols={3}>
  <Card title="Consultar Débitos" icon="magnifying-glass-dollar">
    Busque multas, IPVA, licenciamento e taxas de qualquer veículo brasileiro
  </Card>

  <Card title="Processar Pagamentos" icon="credit-card">
    Aceite pagamentos via cartão de crédito (até 12x) ou PIX
  </Card>

  <Card title="Receber Notificações" icon="bell">
    Configure webhooks para atualizações automáticas de status
  </Card>
</CardGroup>

### Por que escolher a Uvvipague?

<AccordionGroup>
  <Accordion title="Cobertura Nacional Completa" icon="map">
    Acesso a todos os 26 estados brasileiros e Distrito Federal através de uma única API. Sem necessidade de múltiplas integrações ou credenciais diferentes.
  </Accordion>

  <Accordion title="Processamento Rápido e Confiável" icon="bolt">
    Consultas processadas em tempo real com alta disponibilidade. Sistema de retentativas automáticas e fallback para garantir que você sempre receba as notificações.
  </Accordion>

  <Accordion title="Segurança e Compliance" icon="shield-check">
    Antifraude integrado em todas as transações. Tokenização de cartões e conformidade com PCI-DSS. Proteção de dados conforme LGPD.
  </Accordion>

  <Accordion title="Documentação Completa" icon="book">
    Exemplos de código em múltiplas linguagens (JavaScript, Python, PHP, cURL). Guias passo a passo e referência completa da API.
  </Accordion>
</AccordionGroup>

## Comece Agora

<Steps>
  <Step title="Obtenha suas Credenciais">
    Crie sua conta e gere sua API Key no [painel administrativo](https://dashboard.uvvipague.com.br).
  </Step>

  <Step title="Configure a Autenticação">
    Adicione o header `x-api-key` em todas as suas requisições.

    ```bash theme={null}
    x-api-key: SUA_API_KEY_AQUI
    ```
  </Step>

  <Step title="Faça sua Primeira Consulta">
    Teste a API consultando dados de um veículo:

    ```bash theme={null}
    curl --request POST \
      --url 'https://api.uvvipague.com.br/uvvi/v1/debts' \
      --header 'x-api-key: SUA_API_KEY_AQUI' \
      --header 'Content-Type: application/json' \
      --data '{
        "state": "SP",
        "licensePlate": "ABC1234",
        "renavam": "12345678901",
        "cpfCnpj": "12345678900"
      }'
    ```
  </Step>

  <Step title="Configure Webhooks">
    Receba notificações automáticas sobre o status das consultas e pagamentos.
  </Step>
</Steps>

## Débitos Disponíveis

A API permite consultar e liquidar os seguintes tipos de débitos:

<Columns cols={2}>
  <Card title="Multas de Trânsito" icon="triangle-exclamation">
    Consulte e pague multas de trânsito e multas gerenciadas pelo RENAINF.
  </Card>

  <Card title="IPVA" icon="car">
    Acesse débitos de IPVA, incluindo cota única e cotas parceladas.
  </Card>

  <Card title="Licenciamento" icon="file-certificate">
    Consulte e quite taxas de licenciamento do veículo.
  </Card>

  <Card title="Taxas Diversas" icon="receipt">
    Taxas de serviços diversos, como multa de pátio e outros serviços.
  </Card>
</Columns>

## Cobertura Nacional

<CardGroup cols={2}>
  <Card title="27 Unidades Federativas" icon="flag">
    Cobertura completa de todos os 26 estados brasileiros e o Distrito Federal
  </Card>

  <Card title="Integração Única" icon="plug">
    Uma única API para acessar todos os Detrans do país
  </Card>
</CardGroup>

<AccordionGroup>
  <Accordion title="Ver todos os estados suportados" icon="map-location-dot">
    <Columns cols={3}>
      <div>
        **Norte**

        * Acre (AC)
        * Amapá (AP)
        * Amazonas (AM)
        * Pará (PA)
        * Rondônia (RO)
        * Roraima (RR)
        * Tocantins (TO)
      </div>

      <div>
        **Nordeste**

        * Alagoas (AL)
        * Bahia (BA)
        * Ceará (CE)
        * Maranhão (MA)
        * Paraíba (PB)
        * Pernambuco (PE)
        * Piauí (PI)
        * Rio Grande do Norte (RN)
        * Sergipe (SE)
      </div>

      <div>
        **Centro-Oeste**

        * Distrito Federal (DF)
        * Goiás (GO)
        * Mato Grosso (MT)
        * Mato Grosso do Sul (MS)

        **Sudeste**

        * Espírito Santo (ES)
        * Minas Gerais (MG)
        * Rio de Janeiro (RJ)
        * São Paulo (SP)

        **Sul**

        * Paraná (PR)
        * Rio Grande do Sul (RS)
        * Santa Catarina (SC)
      </div>
    </Columns>
  </Accordion>

  <Accordion title="Limitações por Estado" icon="circle-info">
    <Warning>
      **Atenção**: Alguns estados possuem limitações específicas:
    </Warning>

    **Estados com IPVA apenas em cota única:**

    * Goiás (GO)
    * Maranhão (MA)
    * Mato Grosso do Sul (MS)
    * Rio Grande do Sul (RS)

    **Manutenção programada:**

    * **São Paulo (SP)**: Detran-SP realiza manutenções diárias entre **00h e 07h**. Durante este período, consultas para veículos de SP podem estar indisponíveis.
  </Accordion>
</AccordionGroup>

## Recursos Principais

### Consulta e Enriquecimento

<CardGroup cols={2}>
  <Card title="Enriquecimento de Placa" icon="magnifying-glass-chart" href="/enriquecimento-placa">
    Obtenha dados completos do veículo: marca, modelo, ano, cor, chassi, RENAVAM e muito mais.
  </Card>

  <Card title="Consulta de Débitos" icon="file-invoice-dollar" href="/consulta-debitos">
    Busque todos os débitos pendentes: multas, IPVA, licenciamento e taxas diversas.
  </Card>
</CardGroup>

### Pagamentos e Parcelamento

<CardGroup cols={2}>
  <Card title="Simulação de Parcelas" icon="calculator" href="/simulacao-parcelas">
    Simule opções de parcelamento de 1x a 12x com juros transparentes.
  </Card>

  <Card title="Processamento de Pagamentos" icon="credit-card" href="/fluxo-completo#24-efetuar-pagamento">
    Processe pagamentos via cartão de crédito ou PIX com antifraude integrado.
  </Card>
</CardGroup>

### Integração e Segurança

<CardGroup cols={2}>
  <Card title="Autenticação" icon="key" href="/autenticacao">
    Sistema de autenticação via API Key com ambientes de produção e sandbox.
  </Card>

  <Card title="Webhooks" icon="webhook" href="/webhooks">
    Receba notificações automáticas sobre consultas, pagamentos e liquidações.
  </Card>
</CardGroup>

## Guias de Integração

<Tabs>
  <Tab title="Fluxo Completo">
    <Card title="Integração Completa" icon="diagram-project" href="/fluxo-completo">
      Guia passo a passo do fluxo completo: desde a consulta de débitos até o pagamento e liquidação. Inclui exemplos de código em JavaScript e Python.
    </Card>
  </Tab>

  <Tab title="Referência da API">
    <Card title="Referência da API" icon="code" href="/api-reference/introduction">
      Documentação técnica completa de todos os endpoints, parâmetros, respostas e códigos de erro da API.
    </Card>
  </Tab>

  <Tab title="ENUMs e Tipos">
    <Card title="Tipos de Dados" icon="list" href="/enums-tipos">
      Referência completa de todos os enumeradores, tipos de débitos, status de pagamento e códigos de erro.
    </Card>
  </Tab>
</Tabs>

## Casos de Uso

<AccordionGroup>
  <Accordion title="Fintech e Bancos Digitais" icon="building-columns">
    Ofereça pagamento de débitos veiculares como serviço adicional aos seus clientes. Integre a API em seu app mobile ou web banking.

    **Benefícios:**

    * Aumente o engajamento dos clientes
    * Gere receita adicional com taxas de conveniência
    * Diferencie-se da concorrência
  </Accordion>

  <Accordion title="Marketplaces de Veículos" icon="store">
    Valide automaticamente a situação de débitos de veículos anunciados. Ofereça regularização de pendências como parte do processo de venda.

    **Benefícios:**

    * Aumente a confiança dos compradores
    * Acelere o processo de venda
    * Reduza inadimplência pós-venda
  </Accordion>

  <Accordion title="Seguradoras" icon="shield-halved">
    Valide débitos antes de emitir apólices. Ofereça regularização como parte do processo de contratação do seguro.

    **Benefícios:**

    * Reduza riscos de sinistros
    * Melhore a experiência do cliente
    * Automatize processos de validação
  </Accordion>

  <Accordion title="Gestão de Frotas" icon="truck-fast">
    Monitore e regularize débitos de toda a frota de forma centralizada. Receba alertas automáticos de novos débitos.

    **Benefícios:**

    * Evite multas por atraso
    * Mantenha a frota regularizada
    * Reduza custos operacionais
  </Accordion>

  <Accordion title="Aplicativos de Mobilidade" icon="mobile">
    Integre consulta e pagamento de débitos diretamente no seu app. Ofereça como serviço adicional aos motoristas parceiros.

    **Benefícios:**

    * Aumente a retenção de motoristas
    * Gere receita adicional
    * Melhore a experiência do usuário
  </Accordion>
</AccordionGroup>

## Exemplos de Código

Veja como é simples integrar a API Uvvipague:

<CodeGroup>
  ```javascript JavaScript theme={null}
  // Consultar débitos de um veículo
  const response = await fetch('https://api.uvvipague.com.br/uvvi/v1/debts', {
    method: 'POST',
    headers: {
      'x-api-key': process.env.UVVIPAGUE_API_KEY,
      'Content-Type': 'application/json'
    },
    body: JSON.stringify({
      state: 'SP',
      licensePlate: 'ABC1234',
      renavam: '12345678901',
      cpfCnpj: '12345678900',
      externalId: crypto.randomUUID()
    })
  });

  const data = await response.json();
  console.log(`Encontrados ${data.debts.length} débitos`);
  ```

  ```python Python theme={null}
  import requests
  import uuid

  # Consultar débitos de um veículo
  response = requests.post(
      'https://api.uvvipague.com.br/uvvi/v1/debts',
      headers={
          'x-api-key': os.getenv('UVVIPAGUE_API_KEY'),
          'Content-Type': 'application/json'
      },
      json={
          'state': 'SP',
          'licensePlate': 'ABC1234',
          'renavam': '12345678901',
          'cpfCnpj': '12345678900',
          'externalId': str(uuid.uuid4())
      }
  )

  data = response.json()
  print(f'Encontrados {len(data["debts"])} débitos')
  ```

  ```php PHP theme={null}
  <?php
  // Consultar débitos de um veículo
  $curl = curl_init();

  curl_setopt_array($curl, [
      CURLOPT_URL => "https://api.uvvipague.com.br/uvvi/v1/debts",
      CURLOPT_RETURNTRANSFER => true,
      CURLOPT_POST => true,
      CURLOPT_POSTFIELDS => json_encode([
          "state" => "SP",
          "licensePlate" => "ABC1234",
          "renavam" => "12345678901",
          "cpfCnpj" => "12345678900",
          "externalId" => uniqid('', true)
      ]),
      CURLOPT_HTTPHEADER => [
          "x-api-key: " . getenv('UVVIPAGUE_API_KEY'),
          "Content-Type: application/json"
      ],
  ]);

  $response = curl_exec($curl);
  $data = json_decode($response, true);

  echo "Encontrados " . count($data['debts']) . " débitos\n";
  ?>
  ```
</CodeGroup>

## Suporte e Recursos

<CardGroup cols={3}>
  <Card title="Documentação Completa" icon="book-open" href="/api-reference/introduction">
    Explore a documentação técnica completa da API
  </Card>

  <Card title="Fale com o Suporte" icon="headset" href="mailto:suporte@uvvipague.com.br">
    Entre em contato com nossa equipe de suporte
  </Card>

  <Card title="Painel Administrativo" icon="gauge" href="https://dashboard.uvvipague.com.br">
    Acesse o dashboard para gerenciar sua conta
  </Card>
</CardGroup>

<Note>
  **Precisa de ajuda?** Nossa equipe de suporte está disponível para ajudar você em todas as etapas da integração. Entre em contato através do email [suporte@uvvipague.com.br](mailto:suporte@uvvipague.com.br)
</Note>