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

# Etapas e status

> Significado dos códigos usados na consulta e no webhook da proposta

A consulta `GET /v2/proposal/{propostaId}` e o webhook de proposta usam os mesmos códigos. Todo valor vem em par: o número (`enum_...`) e o nome. Prefira tratar o número no seu sistema e usar o nome para exibição e logs.

##  Status da proposta (`enum_status` / `status`)

| Código | Nome | Significado |
| - | - | - |
| 1 | `EM_ANALISE` | A proposta está sendo analisada automaticamente. |
| 2 | `APROVADA` | A proposta foi aprovada e segue para as etapas de formalização. |
| 3 | `RECUSADA` | A proposta foi recusada. O motivo vem em `motivo_recusa`, quando houver. |
| 4 | `CANCELADA` | A proposta foi cancelada. |
| 5 | `ANALISE_MANUAL` | A proposta aguarda análise manual da Credicarro. |
| 6 | `FINALIZADA` | A proposta foi concluída. |
| 7 | `EM_NEGOCIACAO` | A proposta está em negociação. |
| 8 | `EXPIRADA` | A proposta expirou. |
| 9 | `PENDENTE` | A proposta está pendente. |

##  Etapas (`enum_etapa` / `etapa`)

Cada participante (comprador, loja e, quando houver, vendedor) tem a sua etapa ativa em `status_ativo` e o histórico em `etapas_concluidas`. O histórico não inclui a etapa ativa e mostra cada etapa uma vez, com a data mais recente.

| Código | Nome | O que acontece |
| - | - | - |
| 0 | `INDEFINIDO` | Etapa ainda não definida para o participante. |
| 1 | `PROPOSTA_CRIADA` | Proposta enviada para análise. |
| 2 | `PROPOSTA_APROVADA` | Proposta aprovada. |
| 3 | `NOTIFICACAO_VENDEDOR` | Etapa de notificação interna. Não exige ação do integrador. |
| 4 | `ANALISE_BIOMETRIA` | Biometria do participante. |
| 5 | `CONTA_RECEBIMENTO` | Aguardando a [conta de recebimento](https://documentacao.credicarro.com.br/pages/v2/proposal/deposit-account.md) (refinanciamento). |
| 6 | `ENVIO_DOCUMENTOS` | Aguardando o [envio de documentos](https://documentacao.credicarro.com.br/pages/v2/proposal/document.md). |
| 7 | `CORRECAO_DOCUMENTOS` | Algum documento foi recusado e precisa ser reenviado. |
| 8 | `DADOS_VEICULO` | Aguardando os [dados do veículo](https://documentacao.credicarro.com.br/pages/v2/proposal/vehicle-detail.md). |
| 9 | `VISTORIA` | Vistoria do veículo pelo cliente. |
| 10 | `ASSINATURA` | Assinatura do contrato pelo cliente. |
| 11 | `PAGAMENTO` | Pagamento em andamento. |
| 12 | `PROPOSTA_FINALIZADA` | Fluxo concluído. |

##  Situação da etapa (`enum_situacao` / `situacao`)

| Código | Nome | Significado |
| - | - | - |
| 1 | `AGUARDANDO_ENVIO` | Aguardando dados ou arquivos do integrador. |
| 2 | `AGUARDANDO_CLIENTE` | Aguardando uma ação do cliente (biometria, vistoria ou assinatura). |
| 3 | `EM_PROCESSAMENTO` | A Credicarro está processando a etapa. |
| 4 | `PENDENTE_CORRECAO` | Há documento recusado aguardando reenvio. |
| 5 | `BLOQUEADA` | A etapa está bloqueada (por exemplo, biometria reprovada). |
| 6 | `CONCLUIDA` | A proposta foi finalizada. |
| 7 | `CANCELADA` | A proposta foi recusada, cancelada ou expirou. |

##  Responsável pela ação (`enum_responsavel_acao` / `responsavel_acao`)

| Código | Nome | Significado |
| - | - | - |
| 0 | `NENHUM` | Ninguém precisa agir (proposta encerrada). |
| 1 | `CLIENTE` | O cliente precisa agir. |
| 2 | `INTEGRADOR` | Seu sistema precisa enviar algo pela API. |
| 3 | `CREDICARRO` | A Credicarro está cuidando da etapa. |

> **Como a situação é definida**
>
> Com a proposta recusada, cancelada ou expirada, a situação é sempre `CANCELADA` e o responsável é `NENHUM`. Com a proposta finalizada, a situação é `CONCLUIDA` e o responsável é `NENHUM`.
>
> Nos demais casos, depende da etapa:
>
> | Etapa | Situação | Responsável |
> | - | - | - |
> | `CONTA_RECEBIMENTO`, `ENVIO_DOCUMENTOS`, `DADOS_VEICULO` | `AGUARDANDO_ENVIO` | `INTEGRADOR` |
> | `CORRECAO_DOCUMENTOS` | `PENDENTE_CORRECAO` | `INTEGRADOR` |
> | `VISTORIA`, `ASSINATURA` | `AGUARDANDO_CLIENTE` | `CLIENTE` |
> | `ANALISE_BIOMETRIA` com sessão criada | `AGUARDANDO_CLIENTE` | `CLIENTE` |
> | `ANALISE_BIOMETRIA` com biometria reprovada | `BLOQUEADA` | `CREDICARRO` |
> | `ANALISE_BIOMETRIA` nos demais casos | `EM_PROCESSAMENTO` | `CREDICARRO` |
> | `PROPOSTA_FINALIZADA` | `CONCLUIDA` | `NENHUM` |
> | Demais etapas | `EM_PROCESSAMENTO` | `CREDICARRO` |
>
> Na loja, a situação da `ANALISE_BIOMETRIA` acompanha a biometria do comprador.

##  Biometria (`enum_biometria` / `biometria`)

| Código | Nome | Significado |
| - | - | - |
| 0 | `NAO_INICIADA` | A biometria ainda não foi iniciada. |
| 1 | `SESSAO_CRIADA` | A sessão foi criada e o cliente precisa acessá-la pelo link recebido (o mesmo de `link_biometria`). |
| 2 | `EM_ANALISE` | A biometria está em análise. |
| 3 | `APROVADA` | A biometria foi aprovada. |
| 4 | `REPROVADA` | A biometria foi reprovada. |

##  Documentos

Status (`enum_status` / `status` dentro de `documentos`). O `motivo` só aparece quando houver:

| Código | Nome | Significado |
| - | - | - |
| 0 | `RECEBIDO` | Documento recebido. |
| 1 | `VALIDO` | Documento aprovado. |
| 2 | `INVALIDO` | Documento recusado. O motivo vem em `motivo`; reenvie o mesmo tipo. |
| 3 | `EM_ANALISE` | Documento em análise. |
| 4 | `EXCLUIDO` | Documento excluído. |
| 5 | `PENDENTE` | Documento exigido que ainda não foi enviado. Só aparece na consulta, para o comprador e a loja. |

### Documentos exigidos na consulta

Na consulta `GET /v2/proposal/{propostaId}`, o comprador e a loja listam **só os documentos exigidos** na proposta. Cada documento exigido aparece uma vez:

* Enviado, com o status real (`RECEBIDO`, `VALIDO`, `INVALIDO` ou `EM_ANALISE`) e o `motivo`, quando houver
* Ainda não enviado (ou excluído), com `PENDENTE` (5)

| Participante | Modalidade | Documentos exigidos, nesta ordem |
| - | - | - |
| Comprador | Financiamento | `COMPROVANTE_RESIDENCIA`, `COMPROVANTE_RENDA`, `ATPV` (só veículo registrado no RS), `CNH` |
| Comprador | Refinanciamento | `COMPROVANTE_RESIDENCIA`, `DOCUMENTO_VEICULO`, `COMPROVANTE_RENDA`, `CNH` |
| Loja | Financiamento | `LAUDO_ECV`, `DOCUMENTO_VEICULO` |
| Loja | Refinanciamento | Nenhum (a lista vem vazia) |

A `CNH` aceita `CNH` ou `CNH_DIGITAL`. Se só a digital foi enviada, a lista mostra `CNH_DIGITAL` no lugar da `CNH` pendente. Se as duas foram enviadas, as duas aparecem.

Documentos enviados que não estão na tabela (por exemplo, `LAUDO_VISTORIA`) não aparecem na lista do comprador nem da loja. A lista do vendedor mostra todos os documentos enviados, sem `PENDENTE`.

Tipos aceitos no [envio de documentos](https://documentacao.credicarro.com.br/pages/v2/proposal/document.md) (`enum_tipo` / `tipo`):

| Código | Nome | Comprador | Vendedor | Loja |
| - | - | :-: | :-: | :-: |
| 1 | `CNH` | ✓ | ✓ | |
| 2 | `CPF` | | ✓ | |
| 3 | `RG` | | ✓ | |
| 4 | `COMPROVANTE_RENDA` | ✓ | | |
| 5 | `COMPROVANTE_RESIDENCIA` | ✓ | ✓ | |
| 6 | `DOCUMENTO_VEICULO` | ✓ | ✓ | ✓ |
| 7 | `CNH_DIGITAL` | ✓ | ✓ | |
| 8 | `LAUDO_ECV` | | ✓ | ✓ |
| 9 | `LAUDO_VISTORIA` | ✓ | ✓ | |
| 11 | `CARTAO_CNPJ` | | ✓ | |
| 57 | `ATPV` | ✓ | | |

O webhook e a lista do vendedor na consulta podem trazer outros tipos de documento anexados pela Credicarro; eles seguem o mesmo par código e nome.


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