Search
K
Policy

Metrics

Get policy metrics

Policy Metrics

post
https://qa.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:LAPSEPROTECTIONPAYMENTAMOUNTACCOUNTSURRENDERVALUEACCOUNTVALUECOSTOFINSURANCENETDEATHBENEFITEXPENSECHARGEUNITEXPENSECHARGEINTERESTCREDITRATELOANREPAYMENTONETIMEAMOUNTSYSTEMATICLOANREPAYMENTAMOUNTINTERESTCREDITAMOUNTINTERESTLOANAMOUNTPARTIALWITHDRAWALONETIMEAMOUNTINITIALPREMIUMAMOUNTSUBSEQUENTPREMIUMAMOUNTONETIMEPREMIUMAMOUNTNEWLOANAMOUNTTOTALLOANBALANCETOTALCOVERAGEAMOUNTCUMULATIVEGROSSDEATHBENEFITAMOUNTCUMULATIVEPREMIUMSINCEISSUECOVERAGECHARGECOVERAGECREDITINITIALPREMIUMCALCULATEDAMOUNTSUBSEQUENTPREMIUMCALCULATEDAMOUNTONETIMEPREMIUMCALCULATEDAMOUNTSYSTEMATICWITHDRAWALAMOUNTFULLSURRENDERCHARGEPARTIALWITHDRAWALONETIMESURRENDERCHARGESYSTEMATICWITHDRAWALSURRENDERCHARGEREQUIREDMINIMUMDISTRIBUTIONONETIMESURRENDERCHARGEANNUITIZATIONPREMIUMTAXCHARGEDEATHPREMIUMTAXCHARGEFULLSURRENDERPREMIUMTAXCHARGEFULLSURRENDERMARKETVALUEADJUSTMENTCHARGEPARTIALWITHDRAWALONETIMEMARKETVALUEADJUSTMENTCHARGESYSTEMATICWITHDRAWALMARKETVALUEADJUSTMENTCHARGEREQUIREDMINIMUMDISTRIBUTIONONETIMEMARKETVALUEADJUSTMENTCHARGESYSTEMATICREQUIREDMINIMUMDISTRIBUTIONMARKETVALUEADJUSTMENTCHARGERIDERCHARGEFIXEDINTERESTCREDITAMOUNTINDEXCREDITAMOUNTINITIALPREMIUMPAYMENTCHARGESUBSEQUENTPREMIUMPAYMENTCHARGEONETIMEPREMIUMPAYMENTCHARGEPREMIUMTAXAMOUNTFULLSURRENDERAMOUNTREQUIREDMINIMUMDISTRIBUTIONONETIMEAMOUNTSYSTEMATICREQUIREDMINIMUMDISTRIBUTIONAMOUNTSYSTEMATICREQUIREDMINIMUMDISTRIBUTIONSURRENDERCHARGE

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

PolicySearchRequest

object
firstNamestring

policy owner first name

policyNumberstring

number/subjective id of policy. Optionally, you can partial search if SSN is also using partial search (e.g. *1234)

lastNamestring

policy owner last name

fullNamestring

policy owner full name. Optionally support partial search

policyStatusstring

status of policy, needs to be enum

planCodestring

plan code for policy

lastUpdatedstring(date-time)

last time policy was updated

createdAtstring(date-time)

creation time of the policy

ssnstring

Policy owner social security number. SSN should be 9 digits, or the last four (e.g. *1234) when policy number is also last four (partial search)

idstring

reference id of the policy, fully unique

lineOfBusinessstring

line of business to search for, options are LIFE or Annuity Product

partyIdsarray[string]

list of party ids associated with the policy

Example:4fd32e7aecc24888be9c5418d6dc646a, 2739e8897e7141189ccd366f7d054ff0

issueDateFromstring(date)

Start date for issue date range query in YYYY-MM-DD format

Example:2024-01-01

issueDateTostring(date)

End date for issue date range query in YYYY-MM-DD format

Example:2024-12-31

Example

PolicyReferenceDataModel

object
policyNumberstringrequired

number/subjective id of policy

Example:127147468264

planCodestring

plan code for policy

Example:11441

productNamestring

product name of policy

Example:Deluxe Universal Life

firstNamestring

policy owner first name

Example:Nick

lastNamestring

policy owner last name

Example:Burdell

fullNamestring

policy owner full name

Example:Nick Burdell

policyStatusstring

status of policy, needs to be enum

Example:IGO

lineOfBusinessstring

line of business, usually LIFE or ANNUITY

Example:LIFE

restrictionStatusarray[string]

restriction status in SOR

Example:LEGAL

carrierIdstring

4 character id of carrier, also called clientCode or companyCode

Example:ULPC

companyNamestring

Company associated with policyholder

Example:Google

ssnstring

Social security number of policy holder, masked on return

productTypestring

Type of the product

Example:universal

lastUpdatedstring(date-time)

last time policy was updated

createdAtstring(date-time)required

creation date of the policy

idstring

reference id of the policy, fully unique

Example:3cc99edada4f4a88be77cef53ba0b3fd

partyIdsarray[string]

list of party ids associated with the policy

Example:4fd32e7aecc24888be9c5418d6dc646a, 2739e8897e7141189ccd366f7d054ff0

issueDatestring(date)

Issue date of the policy in YYYY-MM-DD format

Example:2024-09-30

Example

PolicySearchResponse

object
totalnumberrequired

Example:121

countnumberrequired

Example:1

nextstringrequired

Example:/policy/v1/policies/search?offset=10&limit=10

previousstringrequired
resultsarray[object]required

array of policy reference data

Show Child Parameters
Example