Skip to main content

Consultar Seguro

Requisição

Endpoint

  • Metodo: GET
  • Endpoint: /v2/policies/{policyId}

Parâmetros (Path)

ParâmetroTipoObrigatórioDescrição
policyIdstring (uuid)Identificador da apólice
Exemplo de requisição
GET /v2/policies/3fa85f64-5717-4562-b3fc-2c963f66afa6

Resposta

Campos da resposta (200)

ParâmetroTipoDescrição
idstring (uuid)Identificador da apólice
activeFromstring (date-time)Início da vigência
activeUntilstring (date-time)Fim da vigência
proposalProposalProposta vinculada
isActivebooleanIndica se a apólice está ativa
proposalDocUrlstring | nullURL do documento da apólice
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-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ódigoHTTPDescrição
NOT_FOUND404Apólice não encontrada.