Criar Proposta
Requisição
Endpoint
- Metodo: POST
- Endpoint:
/v2/proposals
Parâmetros (Body)
| Parâmetro | Tipo | Obrigatório | 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 | EstadoCivil | ✅ | Estado Civil do tomador |
| phone | string | ✅ | Telefone do tomador |
string | ✅ | Email do tomador | |
| creditContractId | string | ✅ | Identificador do contrato de crédito |
| quoteId | string (uuid) | ✅ | Identificador da cotação |
| address | Address | ✅ | Endereço do tomador |
| loanPmtAmount | number | ❌ | Valor da parcela do crédito (não do seguro) |
| firstPmtDueDate | string (date-time) | ❌ | Data de vencimento da primeira parcela do crédito |
Tipo Address
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| street | string | ✅ | Logradouro |
| number | string | ✅ | Número |
| complement | string | ❌ | Complemento |
| zip | string | ✅ | CEP |
| neighborhood | string | ✅ | Bairro |
| city | string | ✅ | Cidade |
| state | string | ✅ | 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â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 |
| 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 |
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ódigo | HTTP | Descrição |
|---|---|---|
NOT_FOUND | 404 | Cotação não encontrada. |
DUPLICATE_PROPOSAL | 409 | Já existe uma proposta ativa para esse contrato. |
AGE_NOT_ACCEPTABLE | 422 | Idade do tomador fora das regras de aceitação. |
INVALID_FIRST_PMT_DATE | 422 | O vencimento da primeira parcela deve ser uma data futura. |
VALIDATION_ERROR | 400 | Um ou mais campos inválidos. |