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

# Convenções da API

> Convenções da API: base URL, autenticação, formato dos campos, paginação e erros

Estas são as convenções que valem para todos os endpoints. Os endpoints ficam nas abas **Autenticação**, **Proposta** e **Webhooks**: cada grupo começa com uma visão geral do recurso e segue com os endpoints, que você pode testar direto no playground.

## Base URL

| Ambiente | Base URL |
| - | - |
| Staging | `https://api.staging.credicarro.com.br/integration` |
| Produção | `https://api.credicarro.com.br/integration` |

## Autenticação

Envie `Authorization: Bearer {token_de_acesso}` em todas as requisições, exceto na geração do token. Veja [Autenticação](https://documentacao.credicarro.com.br/pages/authentication.md).

## Convenções

> **Nomes dos campos**
>
> Os campos são em português. No **corpo das requisições**, os nomes usam `camelCase` (`simulacaoId`, `cnpjLoja`). Nas **respostas**, usam `snake_case` (`id_simulacao`, `valor_parcela`). Exceções: o cadastro de webhook usa `tipo_autenticacao`, e os parâmetros de paginação são `pagina_inicial` e `limite`.

> **CPF e CNPJ**
>
> CPF com 11 dígitos, formatado (`123.456.789-09`) ou só números; os dígitos verificadores são validados. O `cnpjLoja` aceita formatado (`11.222.333/0001-81`) ou só números.

> **Valores monetários**
>
> Em reais, como número com ponto decimal (`45000.50`). Não envie em centavos nem como texto.

> **Placas**
>
> Padrão antigo (`ABC-1234`) ou Mercosul (`ABC1D23`).

> **Datas**
>
> ISO-8601 com fuso horário (`2026-10-12T14:05:08-03:00`).

> **Enumerações**
>
> Na consulta e no webhook da proposta, os códigos vêm em par: o número (`enum_status`) e o nome (`status`). Trate o número no seu sistema e use o nome em telas e logs. Veja [Etapas e status](https://documentacao.credicarro.com.br/pages/v2/steps.md).

> **Campos desconhecidos**
>
> Campos não documentados são ignorados — não geram erro, mas também não têm efeito. Envie só os campos documentados.

## Paginação

As rotas de listagem aceitam `pagina_inicial` (mínimo 1) e `limite` (1 a 100) e respondem sempre no mesmo formato:

```json theme={null}
{
  "itens": [],
  "pagina": {
    "numero": 1,
    "tamanho": 10,
    "total": 45,
    "tem_proximo": true,
    "tem_anterior": false
  }
}
```

## Erros

Os erros trazem `tipo`, `titulo`, `status` e `detalhe` (o `401` vem sem corpo). Use `tipo` no seu tratamento. Veja [Erros e idempotência](https://documentacao.credicarro.com.br/pages/errors.md).

## Recursos

> **[Cliente](https://documentacao.credicarro.com.br/pages/customer/reference.md)**
>
> Cadastro do comprador: dados pessoais, endereço e renda.

> **[Simulação](https://documentacao.credicarro.com.br/pages/v2/simulation/reference.md)**
>
> Faixas e condições de crédito por prazo.

> **[Proposta](https://documentacao.credicarro.com.br/pages/v2/proposal/reference.md)**
>
> Criação, acompanhamento e envio de dados da proposta.

> **[Webhooks](https://documentacao.credicarro.com.br/pages/webhook/reference.md)**
>
> Cadastro das URLs que recebem notificações.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.