Consultar Proposta

Requisição

Endpoint

• Metodo: GET
• Endpoint: /v2/proposals/{proposalId}

Parâmetros (Path)

Parâmetro	Tipo	Obrigatório	Descrição
proposalId	string (uuid)	✅	Identificador da proposta

Exemplo de requisição

GET /v2/proposals/3fa85f64-5717-4562-b3fc-2c963f66afa6

Resposta

Campos da resposta (200)

Parâmetro	Tipo	Descrição
id	string (uuid)	Identificador da proposta
clientId	string (uuid)	Identificador do cliente
status	string	Status da proposta
expiresAt	string (date-time)	Data de expiração da proposta
creditContractId	string	Identificador do contrato de crédito (original, da 1ª contratação)
currentCreditContractId	string | null	Contrato de crédito em vigor após renegociação(ões); null se nunca renegociado
quoteId	string (uuid)	Identificador da cotação
premium	string	Valor cobrado do cliente pelo seguro
luckyNumber	integer | null	Número da sorte (se aplicável)
coverageFrom	string (date-time)	Início da cobertura
coverageUntil	string (date-time)	Fim da cobertura
loan.amount	string	Valor emprestado
loan.periodInMonths	integer	Duração do empréstimo (em meses)
loan.pmtAmount	string | null	Valor da parcela do crédito (não do seguro)
loan.firstPmtDueDate	string (date-time) | null	Data de vencimento da primeira parcela do crédito
person	PersonInfo	Informações do tomador
address	Address	Endereço do tomador
signature	Signature	Informações da assinatura
createdAt	string (date-time)	Data de criação
updatedAt	string (date-time)	Data da última atualização
cancelledAt	string (date-time) | null	Data de cancelamento

Tipo PersonInfo

Parâmetro	Tipo	Descrição
name	string	Nome do tomador
dateOfBirth	string (date)	Data de nascimento do tomador
gender	string	Gênero do tomador
cpf	string	CPF do tomador
maritalStatus	string	Estado Civil do tomador
phone	string	Telefone do tomador
email	string	Email do tomador

Tipo Address

Parâmetro	Tipo	Descrição
street	string	Logradouro
number	string	Número
complement	string | null	Complemento
zip	string	CEP
neighborhood	string	Bairro
city	string	Cidade
state	string	Estado (UF)

Tipo Signature

Parâmetro	Tipo	Descrição
signatureId	string | null	Identificador da assinatura
signedAt	string (date-time) | null	Data de assinatura do contrato
signatureProvider	string | null	Provedor de assinatura

Exemplo (200)

{
  "id": "3fa85f64-5717-4562-b3fc-2c963f66afa4",
  "clientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "status": "PENDING_SIGNATURE",
  "expiresAt": "2025-08-11T02:07:49.030Z",
  "creditContractId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "currentCreditContractId": null,
  "quoteId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "premium": "100.0",
  "luckyNumber": null,
  "coverageFrom": "2025-08-11T00:00:00.000Z",
  "coverageUntil": "2035-08-11T00:00:00.000Z",
  "loan": {
    "amount": "1000.0",
    "periodInMonths": 120,
    "pmtAmount": "95.23",
    "firstPmtDueDate": "2025-09-10T00:00:00.000Z"
  },
  "person": {
    "name": "Fulano de Tal",
    "dateOfBirth": "2000-01-01",
    "gender": "M",
    "cpf": "01234567890",
    "maritalStatus": "SINGLE",
    "phone": "+5551999998888",
    "email": "fulano@mail.com"
  },
  "address": {
    "street": "Rua das Flores",
    "number": "123",
    "complement": "Apto 4",
    "zip": "90010-000",
    "neighborhood": "Centro",
    "city": "Porto Alegre",
    "state": "RS"
  },
  "signature": {
    "signatureId": null,
    "signedAt": null,
    "signatureProvider": null
  },
  "createdAt": "2025-08-10T02:07:49.030Z",
  "updatedAt": "2025-08-10T02:07:49.030Z",
  "cancelledAt": null
}

Erros

Código	HTTP	Descrição
NOT_FOUND	404	Proposta não encontrada.