> ## 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.

# Fluxo de integração

> Ordem de chamadas para levar uma proposta do início ao fim

A API leva a proposta até o fim pelo seu sistema. Depois de criada, você acompanha as etapas de cada participante e envia documentos, dados do veículo e conta de recebimento sem precisar de outro canal.

##  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.

**1. 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](https://documentacao.credicarro.com.br/pages/authentication/accesstoken.md)**
>
> Autenticação

**2. 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](https://documentacao.credicarro.com.br/pages/webhook/create.md)**
>
> Webhooks

**3. 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](https://documentacao.credicarro.com.br/pages/customer/unified.md)**
>
> Cliente

**4. 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](https://documentacao.credicarro.com.br/pages/v2/simulation/range-financing.md)**
>
> Simulação

> **[GET Faixa refinanciável](https://documentacao.credicarro.com.br/pages/v2/simulation/range-refinancing.md)**
>
> Simulação

**5. Simular informando a loja**

Envie `cnpjLoja` na simulação. A resposta traz uma simulação por prazo.

> **[POST Criar simulação de financiamento](https://documentacao.credicarro.com.br/pages/v2/simulation/create-financing.md)**
>
> Simulação

> **[POST Criar simulação de refinanciamento](https://documentacao.credicarro.com.br/pages/v2/simulation/create-refinancing.md)**
>
> Simulação

**6. Criar a proposta**

Escolha um `id_simulacao` da resposta anterior e crie a proposta.

> **[POST Criar proposta](https://documentacao.credicarro.com.br/pages/v2/proposal/create.md)**
>
> Proposta

**7. Acompanhar as etapas**

Consulte a proposta ou use o [webhook de proposta](https://documentacao.credicarro.com.br/pages/v2/webhooks.md). 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](https://documentacao.credicarro.com.br/pages/v2/proposal/get.md)**
>
> Proposta

**8. Enviar o que a etapa pedir**

Cada etapa com `responsavel_acao` = `INTEGRADOR` tem um endpoint próprio.

> **[POST Enviar documento](https://documentacao.credicarro.com.br/pages/v2/proposal/document.md)**
>
> `ENVIO_DOCUMENTOS` e `CORRECAO_DOCUMENTOS`

> **[POST Incluir dados do veículo](https://documentacao.credicarro.com.br/pages/v2/proposal/vehicle-detail.md)**
>
> `DADOS_VEICULO`

> **[POST Incluir conta de recebimento](https://documentacao.credicarro.com.br/pages/v2/proposal/deposit-account.md)**
>
> `CONTA_RECEBIMENTO` (só refinanciamento)

> [!NOTE]
>
> Os significados de cada etapa, situação e status estão em [Etapas e status](https://documentacao.credicarro.com.br/pages/v2/steps.md).

##  Guias com exemplos

> **[Financiamento ponta a ponta](https://documentacao.credicarro.com.br/pages/guides/financing-integration.md)**
>
> Todas as chamadas, com requisição e resposta.

> **[Refinanciamento ponta a ponta](https://documentacao.credicarro.com.br/pages/guides/refinancing-integration.md)**
>
> Inclui a conta de recebimento.

> **[Envio de documentos](https://documentacao.credicarro.com.br/pages/guides/document-upload.md)**
>
> Base64, idempotência e correção.


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