> ## 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. # Buscar proposta > Consulta o retrato atual de uma proposta, com status, link de biometria e as etapas e os documentos do comprador, da loja e, quando houver, do vendedor. Em `documentos`, o comprador e a loja listam só os documentos exigidos na proposta: os enviados com o status real e os que faltam com `PENDENTE` (5). O vendedor lista todos os documentos enviados. Retorna o retrato atual da proposta: status, `link_biometria` e, para o comprador, a loja e, quando houver, o vendedor, a etapa ativa, a situação, quem precisa agir, as etapas concluídas e os documentos. > [!TIP] > > Leia `status_ativo.responsavel_acao` de cada participante. Quando for `INTEGRADOR`, a `etapa` diz o que enviar. Veja a [referência de proposta](https://documentacao.credicarro.com.br/pages/v2/proposal/reference.md#como-decidir-o-proximo-passo). > [!TIP] > > Para o comprador e a loja, `documentos` traz os documentos exigidos na proposta. Os que ainda faltam vêm com `status` = `PENDENTE` (5). Veja [quais documentos são exigidos](https://documentacao.credicarro.com.br/pages/v2/steps.md#documentos-exigidos-na-consulta). > [!TIP] > > A Credicarro envia o link da biometria ao cliente por WhatsApp e e-mail na aprovação. Se a sua integração conduz o contato com o cliente, repasse o `link_biometria`. ## OpenAPI ````yaml GET /v2/proposal/{propostaId} openapi: 3.1.0 info: title: API Credicarro description: API para gerenciamento de cobranças e pagamentos usando o Credicarro. version: 1.0.0 servers: - url: https://api.staging.credicarro.com.br/integration description: Servidor para o ambiente de staging - url: https://api.credicarro.com.br/integration description: Servidor para o ambiente de produção security: [] paths: /v2/proposal/{propostaId}: get: tags: - Proposta summary: Consultar proposta pelo ID. description: > Consulta o retrato atual de uma proposta, com status, link de biometria e as etapas e os documentos do comprador, da loja e, quando houver, do vendedor. Em `documentos`, o comprador e a loja listam só os documentos exigidos na proposta: os enviados com o status real e os que faltam com `PENDENTE` (5). O vendedor lista todos os documentos enviados. parameters: - $ref: '#/components/parameters/ProposalId' responses: '200': description: Proposta retornada com sucesso content: application/json: schema: $ref: '#/components/schemas/ProposalV2Response' '400': description: Erro na requisição content: application/json: schema: $ref: '#/components/schemas/ProblemDetails' '403': $ref: '#/components/responses/IntegrationInactive' '404': description: >- Proposta não encontrada para este parceiro (`Proposal.Access.NotFound`) ou cliente da proposta não encontrado (`Proposal.Customer.ProfileNotFound`) content: application/json: schema: $ref: '#/components/schemas/ProblemDetails' '422': description: >- Proposta não disponível nesta rota (`Proposal.Access.NotIntegrationV2`) content: application/json: schema: $ref: '#/components/schemas/ProblemDetails' security: - bearerAuth: [] components: parameters: ProposalId: name: propostaId in: path required: true description: Identificador único da proposta (UUID) retornado na criação da proposta schema: type: string format: uuid example: bea8d060-f93d-48eb-b6c4-45f64483cdd9 schemas: ProposalV2Response: type: object description: Retrato atual da proposta properties: id_proposta: type: string format: uuid example: bea8d060-f93d-48eb-b6c4-45f64483cdd9 numero: type: integer format: int64 description: Número único da proposta example: 171020250001 id_simulacao: type: string format: uuid example: 123e4567-e89b-12d3-a456-426614174000 enum_status: type: integer format: int32 description: Código do status da proposta (veja "Etapas e status") example: 2 status: type: string description: Nome do status da proposta enum: - EM_ANALISE - APROVADA - RECUSADA - CANCELADA - ANALISE_MANUAL - FINALIZADA - EM_NEGOCIACAO - EXPIRADA - PENDENTE example: APROVADA tipo: type: string description: Modalidade da proposta enum: - Financing - Refinancing example: Refinancing data_criacao: type: string format: date-time example: '2026-10-12T17:05:08.984Z' motivo_recusa: type: string nullable: true description: Motivo da recusa, quando houver. Omitido quando vazio. example: Restrição cadastral link_biometria: type: string nullable: true description: >- Link para o cliente realizar a biometria, quando disponível. Omitido quando vazio. example: https://onboarding.exemplo.com/sessao/abc123 comprador: $ref: '#/components/schemas/ProposalV2Participant' vendedor: $ref: '#/components/schemas/ProposalV2Participant' loja: $ref: '#/components/schemas/ProposalV2Store' ProblemDetails: type: object properties: tipo: type: string description: Tipo de problema encontrado example: Validation.Cpf.Invalid titulo: type: string description: Título do erro example: Requisição inválida status: type: integer format: int32 description: Status Code do erro example: 400 detalhe: type: string description: Descrição do erro example: O CPF informado em 'cpf' é inválido. campo: type: string nullable: true description: Campo da requisição relacionado ao erro, quando houver example: cpf erros: type: array description: >- Lista de erros. Presente só quando o JSON enviado está malformado ou tem um valor de tipo errado. items: type: object properties: codigo: type: string description: Código estável do erro example: Validation.InvalidFormat mensagem: type: string description: Mensagem em português example: O valor informado para 'valorVeiculo' não é um número válido. campo: type: string nullable: true description: Campo inválido, quando houver example: cpf additionalProperties: false ProposalV2Participant: type: object properties: cpf: type: string example: '12345678909' enum_biometria: type: integer format: int32 description: Código da situação da biometria example: 3 biometria: type: string enum: - NAO_INICIADA - SESSAO_CRIADA - EM_ANALISE - APROVADA - REPROVADA example: APROVADA status_ativo: $ref: '#/components/schemas/ProposalV2ActiveStep' etapas_concluidas: type: array items: $ref: '#/components/schemas/ProposalV2CompletedStep' documentos: type: array items: $ref: '#/components/schemas/ProposalV2Document' ProposalV2Store: type: object description: >- Etapas da loja de integração. Presente quando a proposta foi feita em loja. properties: cnpj: type: string example: '11222333000181' status_ativo: $ref: '#/components/schemas/ProposalV2ActiveStep' etapas_concluidas: type: array items: $ref: '#/components/schemas/ProposalV2CompletedStep' documentos: type: array items: $ref: '#/components/schemas/ProposalV2Document' ProposalV2ActiveStep: type: object description: >- Etapa em que o participante está agora, a situação dela e quem precisa agir properties: enum_etapa: type: integer format: int32 example: 6 etapa: type: string enum: - INDEFINIDO - PROPOSTA_CRIADA - PROPOSTA_APROVADA - NOTIFICACAO_VENDEDOR - ANALISE_BIOMETRIA - CONTA_RECEBIMENTO - ENVIO_DOCUMENTOS - CORRECAO_DOCUMENTOS - DADOS_VEICULO - VISTORIA - ASSINATURA - PAGAMENTO - PROPOSTA_FINALIZADA example: ENVIO_DOCUMENTOS enum_situacao: type: integer format: int32 example: 1 situacao: type: string enum: - AGUARDANDO_ENVIO - AGUARDANDO_CLIENTE - EM_PROCESSAMENTO - PENDENTE_CORRECAO - BLOQUEADA - CONCLUIDA - CANCELADA example: AGUARDANDO_ENVIO enum_responsavel_acao: type: integer format: int32 example: 2 responsavel_acao: type: string enum: - NENHUM - CLIENTE - INTEGRADOR - CREDICARRO example: INTEGRADOR ProposalV2CompletedStep: type: object properties: enum_etapa: type: integer format: int32 example: 4 etapa: type: string example: ANALISE_BIOMETRIA data: type: string format: date-time description: Data da última passagem pela etapa example: '2026-10-12T17:20:00.000Z' ProposalV2Document: type: object properties: enum_tipo: type: integer format: int32 example: 1 tipo: type: string example: CNH enum_status: type: integer format: int32 description: >- Código do status do documento. `5` (`PENDENTE`) indica documento exigido ainda não enviado example: 2 status: type: string enum: - RECEBIDO - VALIDO - INVALIDO - EM_ANALISE - EXCLUIDO - PENDENTE example: INVALIDO motivo: type: string nullable: true description: Motivo da recusa do documento. Omitido quando vazio example: Documento ilegível responses: IntegrationInactive: description: >- Integração do parceiro inativa ou não encontrada (`Integration.Access.Inactive`, `Integration.Access.OrganizationNotFound`) content: application/json: schema: $ref: '#/components/schemas/ProblemDetails' securitySchemes: bearerAuth: type: http scheme: bearer bearerFormat: JWT description: >- Cabeçalho de autenticação Bearer no formato `Bearer ` onde `` é seu TOKEN de autenticação ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.