Search
K
Policy

Metrics

post
https://api.zinnia.io/policy/v1/policies/{planCode}/{policyNumber}/metrics

Path Parameters

planCodestringrequired
policyNumberstringrequired

Body

application/json

PolicyMetricsRequest

startDatestring

Start Date

Example:2024-02-02

endDatestring

End Date

Example:2024-02-02

metricsarray[string]

Allowed values:LAPSEPROTECTIONPAYMENTAMOUNTACCOUNTSURRENDERVALUEACCOUNTVALUECOSTOFINSURANCENETDEATHBENEFITEXPENSECHARGEUNITEXPENSECHARGEINTERESTCREDITRATELOANREPAYMENTONETIMEAMOUNTSYSTEMATICLOANREPAYMENTAMOUNTINTERESTCREDITAMOUNTINTERESTLOANAMOUNTPARTIALWITHDRAWALONETIMEAMOUNTINITIALPREMIUMAMOUNTSUBSEQUENTPREMIUMAMOUNTONETIMEPREMIUMAMOUNTNEWLOANAMOUNTTOTALLOANBALANCETOTALCOVERAGEAMOUNTCUMULATIVEGROSSDEATHBENEFITAMOUNTCUMULATIVEPREMIUMSINCEISSUECOVERAGECHARGECOVERAGECREDITINITIALPREMIUMCALCULATEDAMOUNTSUBSEQUENTPREMIUMCALCULATEDAMOUNTONETIMEPREMIUMCALCULATEDAMOUNTSYSTEMATICWITHDRAWALAMOUNTFULLSURRENDERCHARGEPARTIALWITHDRAWALONETIMESURRENDERCHARGESYSTEMATICWITHDRAWALSURRENDERCHARGEREQUIREDMINIMUMDISTRIBUTIONONETIMESURRENDERCHARGEANNUITIZATIONPREMIUMTAXCHARGEDEATHPREMIUMTAXCHARGEFULLSURRENDERPREMIUMTAXCHARGEFULLSURRENDERMARKETVALUEADJUSTMENTCHARGEPARTIALWITHDRAWALONETIMEMARKETVALUEADJUSTMENTCHARGESYSTEMATICWITHDRAWALMARKETVALUEADJUSTMENTCHARGEREQUIREDMINIMUMDISTRIBUTIONONETIMEMARKETVALUEADJUSTMENTCHARGESYSTEMATICREQUIREDMINIMUMDISTRIBUTIONMARKETVALUEADJUSTMENTCHARGE

Response

application/json

OK

metricstring

Requested metric

Example:LAPSEPROTECTIONPAYMENTAMOUNT

beginnumber(double)

TBD

Example:28.44

minimumnumber(double)

TBD

Example:28.44

maximumnumber(double)

TBD

Example:28.44

averagenumber(double)

TBD

Example:28.44

sumnumber(double)

TBD

Example:8389.8

countinteger(int64)

TBD

Example:295

endnumber(double)

TBD

Example:28.44

post/policy/v1/policies/{planCode}/{policyNumber}/metrics

Body

{}
 
application/json

PolicyEvent

object
policyNumberstring

The Policy Number is a unique identifier assigned to a life insurance or annuity contract by the insurance carrier. It serves as the official reference number for tracking, managing, and servicing the policy throughout its lifetime

eventstring

The transaction type of the current policy snapshot

timestampstring(date-time)
versioninteger(int32)
Example

ErrorResponse

object
timestampstring(date-time)

Example:2023-01-01T12:00:00.000Z

messagestring
Example

ProductType

string

Allowed values:WHOLELIFEUNIVERSALLIFEVARIABLEUNIVERSALLIFEVARIABLEWHOLELIFEINDEXEDUNIVERSALLIFEFIXEDANNUITYFIXEDINDEXEDANNUITYTERMTERMWITHCASHVALUE

DistributionType

string

Allowed values:WIREHOUSEREGISTEREDINVESTMENTADVISERINDEPENDENTAGENCYFINANCIALPLANNINGFIRMFINANCIALINSTITUTIONBROKER_DEALERTHIRDPARTYDIRECTTOCONSUMERBANKMARKETBROKERAGE_INDEPENDENTMARKETCAPTIVEMARKETAFFILIATEDAGENCYINSTITUTIONALMARKETFARMERSMLEA