Skip to main content
GET
Consultar proposta pelo ID.
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.
Leia status_ativo.responsavel_acao de cada participante. Quando for INTEGRADOR, a etapa diz o que enviar. Veja a referência de proposta.
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.
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.

Authorizations

Authorization
string
header
required

Cabeçalho de autenticação Bearer no formato Bearer <token> onde <token> é seu TOKEN de autenticação

Path Parameters

propostaId
string<uuid>
required

Identificador único da proposta (UUID) retornado na criação da proposta

Example:

"bea8d060-f93d-48eb-b6c4-45f64483cdd9"

Response

Proposta retornada com sucesso

Retrato atual da proposta

id_proposta
string<uuid>
Example:

"bea8d060-f93d-48eb-b6c4-45f64483cdd9"

numero
integer<int64>

Número único da proposta

Example:

171020250001

id_simulacao
string<uuid>
Example:

"123e4567-e89b-12d3-a456-426614174000"

enum_status
integer<int32>

Código do status da proposta (veja "Etapas e status")

Example:

2

status
enum<string>

Nome do status da proposta

Available options:
EM_ANALISE,
APROVADA,
RECUSADA,
CANCELADA,
ANALISE_MANUAL,
FINALIZADA,
EM_NEGOCIACAO,
EXPIRADA,
PENDENTE
Example:

"APROVADA"

tipo
enum<string>

Modalidade da proposta

Available options:
Financing,
Refinancing
Example:

"Refinancing"

data_criacao
string<date-time>
Example:

"2026-10-12T17:05:08.984Z"

motivo_recusa
string | null

Motivo da recusa, quando houver. Omitido quando vazio.

Example:

"Restrição cadastral"

Link para o cliente realizar a biometria, quando disponível. Omitido quando vazio.

Example:

"https://onboarding.exemplo.com/sessao/abc123"

comprador
object
vendedor
object
loja
object

Etapas da loja de integração. Presente quando a proposta foi feita em loja.