Skip to main content

Criar Proposta

Requisição​

Endpoint​

  • Metodo: POST
  • Endpoint: /v2/proposals

Parâmetros (Body)​

ParâmetroTipoObrigatórioDescrição
namestring✅Nome do tomador
dateOfBirthstring (date)✅Data de nascimento do tomador
genderstring✅Gênero do tomador
cpfstring✅CPF do tomador
maritalStatusEstadoCivil✅Estado Civil do tomador
phonestring✅Telefone do tomador
emailstring✅Email do tomador
creditContractIdstring✅Identificador do contrato de crédito
quoteIdstring (uuid)✅Identificador da cotação
addressAddress✅Endereço do tomador
loanPmtAmountnumber❌Valor da parcela do crédito (não do seguro)
firstPmtDueDatestring (date-time)❌Data de vencimento da primeira parcela do crédito

Tipo Address​

ParâmetroTipoObrigatórioDescrição
streetstring✅Logradouro
numberstring✅Número
complementstring❌Complemento
zipstring✅CEP
neighborhoodstring✅Bairro
citystring✅Cidade
statestring✅Estado (UF)
Exemplo de corpo
{
"name": "Fulano de Tal",
"dateOfBirth": "2000-01-01",
"gender": "M",
"cpf": "01234567890",
"maritalStatus": "SINGLE",
"phone": "+5551998043043",
"email": "fulano@mail.com",
"creditContractId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"quoteId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"loanPmtAmount": 95.23,
"firstPmtDueDate": "2025-09-10T00:00:00.000Z",
"address": {
"street": "Rua das Flores",
"number": "123",
"complement": "Apto 4",
"zip": "90010-000",
"neighborhood": "Centro",
"city": "Porto Alegre",
"state": "RS"
}
}

Resposta​

Campos da resposta (200)​

ParâmetroTipoDescrição
idstring (uuid)Identificador da proposta
clientIdstring (uuid)Identificador do cliente
statusstringStatus da proposta
expiresAtstring (date-time)Data de expiração da proposta
creditContractIdstringIdentificador do contrato de crédito
quoteIdstring (uuid)Identificador da cotação
premiumstringValor cobrado do cliente pelo seguro
luckyNumberinteger | nullNúmero da sorte (se aplicável)
coverageFromstring (date-time)Início da cobertura
coverageUntilstring (date-time)Fim da cobertura
loan.amountstringValor emprestado
loan.periodInMonthsintegerDuração do empréstimo (em meses)
loan.pmtAmountstring | nullValor da parcela do crédito (não do seguro)
loan.firstPmtDueDatestring (date-time) | nullData de vencimento da primeira parcela do crédito
personPersonInfoInformações do tomador
addressAddressEndereço do tomador
signatureSignatureInformações da assinatura
createdAtstring (date-time)Data de criação
updatedAtstring (date-time)Data da última atualização
cancelledAtstring (date-time) | nullData de cancelamento
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",
"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ódigoHTTPDescrição
NOT_FOUND404Cotação não encontrada.
DUPLICATE_PROPOSAL409Já existe uma proposta ativa para esse contrato.
AGE_NOT_ACCEPTABLE422Idade do tomador fora das regras de aceitação.
INVALID_FIRST_PMT_DATE422O vencimento da primeira parcela deve ser uma data futura.
VALIDATION_ERROR400Um ou mais campos inválidos.