Base URL
Autenticação
EnvieAuthorization: Bearer {token_de_acesso} em todas as requisições, exceto na geração do token. Veja Autenticação.
Convenções
Nomes dos campos
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 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
Valores monetários
Em reais, como número com ponto decimal (
45000.50). Não envie em centavos nem como texto.Placas
Placas
Padrão antigo (
ABC-1234) ou Mercosul (ABC1D23).Datas
Datas
ISO-8601 com fuso horário (
2026-10-12T14:05:08-03:00).Enumerações
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.Campos desconhecidos
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 aceitampagina_inicial (mínimo 1) e limite (1 a 100) e respondem sempre no mesmo formato:
Erros
Os erros trazemtipo, titulo, status e detalhe (o 401 vem sem corpo). Use tipo no seu tratamento. Veja Erros e idempotência.
Recursos
Cliente
Cadastro do comprador: dados pessoais, endereço e renda.
Simulação
Faixas e condições de crédito por prazo.
Proposta
Criação, acompanhamento e envio de dados da proposta.
Webhooks
Cadastro das URLs que recebem notificações.