Consultar Seguro
Requisição
Endpoint
- Metodo: GET
- Endpoint:
/v2/policies/{policyId}
Parâmetros (Path)
| Parâmetro | Tipo | Obrigatório | Descrição |
|---|---|---|---|
| policyId | string (uuid) | ✅ | Identificador da apólice |
Exemplo de requisição
GET /v2/policies/3fa85f64-5717-4562-b3fc-2c963f66afa6
Resposta
Campos da resposta (200)
| Parâmetro | Tipo | Descrição |
|---|---|---|
| id | string (uuid) | Identificador da apólice |
| activeFrom | string (date-time) | Início da vigência |
| activeUntil | string (date-time) | Fim da vigência |
| proposal | Proposal | Proposta vinculada |
| isActive | boolean | Indica se a apólice está ativa |
| proposalDocUrl | string | null | URL do documento da apólice |
| 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-2c963f66afa6",
"activeFrom": "2025-08-11T00:00:00.000Z",
"activeUntil": "2035-08-11T00:00:00.000Z",
"proposal": {
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa4",
"clientId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"status": "SIGNED",
"creditContractId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"premium": "100.0"
},
"isActive": true,
"proposalDocUrl": "https://url.to/policy/file.pdf",
"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 | Apólice não encontrada. |