Skip to main content

Consultar Proposta

Requisição

Endpoint

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

Parâmetros (Path)

ParâmetroTipoObrigatórioDescrição
proposal_idstring (uuid)Identificador da proposta
Exemplo de requisição
GET /v2/proposals/3fa85f64-5717-4562-b3fc-2c963f66afa6

Resposta

Campos da resposta (200)

ParâmetroTipoDescrição
idstring (uuid)Identificador da proposta
client_idstring (uuid)Identificador do cliente
statusstringStatus da proposta
expires_atstring (date-time)Data de expiração da proposta
credit_contract_idstringIdentificador do contrato de crédito
quote_idstring (uuid)Identificador da cotação
premiumstringPrêmio do seguro
lucky_numberinteger | nullNúmero da sorte (se aplicável)
coverage_fromstring (date-time)Início da cobertura
coverage_untilstring (date-time)Fim da cobertura
loan.amountstringValor emprestado
loan.period_in_monthsintegerDuração do empréstimo (em meses)
personPersonInfoInformações do tomador
addressAddressEndereço do tomador
signatureSignatureInformações da assinatura
created_atstring (date-time)Data de criação
updated_atstring (date-time)Data da última atualização
cancelled_atstring (date-time) | nullData de cancelamento

Tipo PersonInfo

ParâmetroTipoDescrição
namestringNome do tomador
date_of_birthstring (date)Data de nascimento do tomador
genderstringGênero do tomador
cpfstringCPF do tomador
marital_statusstringEstado Civil do tomador
phonestringTelefone do tomador
emailstringEmail do tomador

Tipo Address

ParâmetroTipoDescrição
streetstringLogradouro
numberstringNúmero
complementstring | nullComplemento
zipstringCEP
neighborhoodstringBairro
citystringCidade
statestringEstado (UF)

Tipo Signature

ParâmetroTipoDescrição
signature_idstring | nullIdentificador da assinatura
signed_atstring (date-time) | nullData de assinatura do contrato
signature_providerstring | nullProvedor de assinatura
Exemplo (200)
{
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa4",
"client_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"status": "PENDING_SIGNATURE",
"expires_at": "2025-08-11T02:07:49.030Z",
"credit_contract_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"quote_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"premium": "100.0",
"lucky_number": null,
"coverage_from": "2025-08-11T00:00:00.000Z",
"coverage_until": "2035-08-11T00:00:00.000Z",
"loan": {
"amount": "1000.0",
"period_in_months": 120
},
"person": {
"name": "Fulano de Tal",
"date_of_birth": "2000-01-01",
"gender": "M",
"cpf": "01234567890",
"marital_status": "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": {
"signature_id": null,
"signed_at": null,
"signature_provider": null
},
"created_at": "2025-08-10T02:07:49.030Z",
"updated_at": "2025-08-10T02:07:49.030Z",
"cancelled_at": null
}

Erros

CódigoHTTPDescrição
NOT_FOUND404Proposta não encontrada.