Skip to main content

Consultar Seguro

Requisição

Endpoint

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

Parâmetros (Path)

ParâmetroTipoObrigatórioDescrição
policy_idstring (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
active_fromstring (date-time)Início da vigência
active_untilstring (date-time)Fim da vigência
proposalProposalProposta vinculada
is_activebooleanIndica se a apólice está ativa
proposal_doc_urlstring | nullURL do documento da apólice
created_atstring (date-time)Data de criação
updated_atstring (date-time)Data da última atualização
cancelled_atstring (date-time) | nullData de cancelamento
Exemplo (200)
{
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"active_from": "2025-08-11T00:00:00.000Z",
"active_until": "2035-08-11T00:00:00.000Z",
"proposal": {
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa4",
"client_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"status": "SIGNED",
"credit_contract_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"premium": "100.0"
},
"is_active": true,
"proposal_doc_url": "https://url.to/policy/file.pdf",
"created_at": "2025-08-10T02:07:49.030Z",
"updated_at": "2025-08-10T02:07:49.030Z",
"cancelled_at": null
}

Erros

CódigoHTTPDescrição
NOT_FOUND404Apólice não encontrada.