O que a integração oferece
Loja informada pelo CNPJ
As simulações exigem o campo
cnpjLoja. A loja precisa estar vinculada ao seu cadastro de parceiro e não pode ter contrato de intermediação.Etapas por participante
A consulta da proposta traz a etapa ativa, a situação e quem precisa agir para o comprador e para a loja.
Envio de dados pela API
Documentos, dados do veículo e conta de recebimento são enviados por endpoints próprios.
Webhook detalhado
Cada proposta gera um webhook com o retrato completo da proposta a cada mudança de status, etapa ou documento.
Passo a passo
Os endpoints devem ser chamados na seguinte ordem.Gerar token de acesso
Autentique-se com seu
clientId e clientSecret para obter o Bearer token usado em todas as chamadas seguintes.POST Gerar token de acesso
Autenticação
Cadastrar o webhook de proposta
Cadastre uma URL com
tipo = 3 (Proposal) e guarde o segredo_assinatura retornado. Basta fazer isso uma vez.POST Cadastrar webhook
Webhooks
Cadastrar o cliente
A proposta só é aceita com o cadastro completo: dados pessoais, endereço, tipo de ocupação e renda. O endpoint unificado envia tudo de uma vez.
POST Criar ou atualizar cliente com dados completos
Cliente
Consultar a faixa (opcional)
Consulte a entrada mínima por prazo (financiamento) ou o valor mínimo e máximo (refinanciamento) antes de simular, informando o
cnpjLoja.GET Faixa financiável
Simulação
GET Faixa refinanciável
Simulação
Simular informando a loja
Envie
cnpjLoja na simulação. A resposta traz uma simulação por prazo.POST Criar simulação de financiamento
Simulação
POST Criar simulação de refinanciamento
Simulação
Criar a proposta
Escolha um
id_simulacao da resposta anterior e crie a proposta.POST Criar proposta
Proposta
Acompanhar as etapas
Consulte a proposta ou use o webhook de proposta. Quando
responsavel_acao for INTEGRADOR, a etapa ativa indica o que enviar. Quando for CLIENTE, o cliente precisa agir — por exemplo, fazer a biometria pelo link que a Credicarro envia na aprovação.GET Buscar proposta
Proposta
Enviar o que a etapa pedir
Cada etapa com
responsavel_acao = INTEGRADOR tem um endpoint próprio.POST Enviar documento
ENVIO_DOCUMENTOS e CORRECAO_DOCUMENTOSPOST Incluir dados do veículo
DADOS_VEICULOPOST Incluir conta de recebimento
CONTA_RECEBIMENTO (só refinanciamento)Os significados de cada etapa, situação e status estão em Etapas e status.
Guias com exemplos
Financiamento ponta a ponta
Todas as chamadas, com requisição e resposta.
Refinanciamento ponta a ponta
Inclui a conta de recebimento.
Envio de documentos
Base64, idempotência e correção.