Get policy status

GET

/credit-life/policies/{policyId}/status

Authorizations

BearerAuth

Type

HTTP (bearer)

Parameters

Path Parameters

policyId*

Type

string

Required

Responses

Whether the policy's cover is in force for the current period, and what is unpaid. InGrace means cover is still on risk but the period's premium is outstanding; it lapses at graceEndsAt.

Content-Type

application/json

{

  

"status": "string",

  

"currentPeriodIndex": 0,

  

"currentPeriodStart": "string",

  

"currentPeriodEnd": "string",

  

"graceEndsAt": "string",

  

"unpaidPeriods": [

  

  

0

  

],

  

"premiumPerPeriod": 0,

  

"totalCoveredAmount": 0,

  

"aggregateClaimLimit": 0,

  

"uncoveredAmount": 0

}

GET

/credit-life/policies/{policyId}/status

Playground

Authorization

BearerAuth

Variables

Key

Value

policyId*

Samples