跳到主要内容

Início

A apólice (policy) é o contrato de seguro individual — uma por produto vendido em um pedido emitido. Ela nasce logo após a emissão do pedido e passa a ser a fonte da verdade sobre a cobertura: número da apólice, vigência, coberturas efetivas, prêmio decomposto e trilha de eventos.

Ciclo de vida da apólice​

Fluxo de status da apólice, da criação ao cancelamento ou ao fim da vigência

Como ler o diagrama: azul = apólice em vigor · vermelho = cancelada (gera webhook) · verde = encerramento natural (não gera webhook).

StatusSignificado
activeA apólice está em vigor desde a criação. A confirmação da emissão pela seguradora não muda o status: ela aparece como o external_policy_number preenchido e gera o webhook issued. Até lá, o external_policy_number é null.
canceledA apólice foi cancelada — pelo cancelamento da apólice, pelo cancelamento do pedido depois da emissão ou pela seguradora. O status muda no momento do cancelamento e gera o webhook canceled.
finishedA vigência chegou ao fim (term.end_date). Status terminal, sem webhook — o fim de vigência é conhecido desde a emissão.

Devolução de prêmio no cancelamento​

A devolução, quando devida, é calculada sobre o que já foi pago, a partir do momento da solicitação do cancelamento:

  • Até 7 dias corridos da contratação — direito de arrependimento: devolução integral do que foi pago.
  • Após 7 dias: devolução proporcional — a parte do que foi pago que excede o período de cobertura já decorrido.

Endpoints​

EndpointDescrição
GET /v1/insurance/policies/{policy_key}Detalha uma apólice.
GET /v1/insurance/policies?order_key=Lista as apólices de um pedido emitido.
POST /v1/insurance/policies/{policy_key}/cancelCancela uma apólice individualmente.