Search
K
Policy

Get Policy Coverage

get
https://qa.api.zinnia.io/policy/v1/policies/{planCode}/{policyNumber}/coverage

Path Parameters

planCodestringrequired
policyNumberstringrequired

Response

application/json

OK

PolicyCoverage

totalCoverageAmountnumber(double)

The Total Coverage Amount refers to the maximum benefit or sum insured that a policyholder or beneficiary is entitled to receive under a life insurance contract. It represents the total financial protection provided by the policy

Example:300000

cumulativeGrossDeathBenefitAmountnumber(double)

The Cumulative Gross Death Benefit refers to the total amount payable to a beneficiary upon the insured or annuitant death, before any deductions such as loans, outstanding premiums, or surrender charges. It represents the gross value of the death benefit provided under a life insurance or annuity contract. It is cumulative gross death benefit of all the layers of base coverage (not including riders ).

Example:300000

netDeathBenefitnumber(double)

The Net Death Benefit refers to the actual amount paid to the beneficiary upon the insured or annuitant death, after deductions such as policy loans, unpaid premiums, withdrawals, or other charges

Example:300000

remainingDeathBenefitAmountnumber(double)

The Remaining Death Benefit Amount refers to the portion of the death benefit that is still available as of date for benefit payment to beneficiaries after a partial claim has been taken

Example:300000

minimumCoverageAmountnumber(double)

The Minimum Coverage Amount refers to the lowest amount of death benefit or policy coverage that an insurance company allows for a life insurance contract. It is the smallest sum insured that can be purchased under a specific product type

Example:10000

maximumCoverageAmountnumber(double)

The Maximum Coverage Amount refers to the highest amount of death benefit or policy coverage that an insurance company will issue under a life insurance contract. It represents the largest sum insured that an applicant can qualify for based on underwriting and financial eligibility

Example:10000000

coverageChangeEffectiveDatestring

The Earliest Coverage Change Date refers to the first possible date when a modification to an insurance policy can take effect. It defines the earliest point at which a policyholder can adjust coverage levels, add or remove riders, or make other contractual changes based on policy terms and conditions

Example:2023-01-01

coverageBandstring

In life insurance, a band refers to a coverage range or tier that affects premium rates, underwriting guidelines, or policy benefits. Insurance companies use coverage bands to determine pricing structures, offering lower per-unit costs for higher coverage amounts

Allowed values:BAND1BAND2BAND3BAND4BAND5BAND6BAND7

maximumAnnualCoverageChangeAllowedPerPolicyinteger(int32)

The Maximum Annual Coverage Change Allowed per Policy refers to the largest increase or decrease in coverage amount permitted within a single policy year, as defined by the insurance carrier. This limit is set to maintain policy stability, prevent excessive risk exposure, and ensure compliance with underwriting and policy guidelines

Example:1

minimumCoverageDecreaseAmountnumber(double)

The Minimum Coverage Amount Decrease refers to the smallest reduction in coverage that a policyholder is allowed to make per policy year, as defined by the insurance carrier. This ensures that policies remain viable and do not fall below the required minimum coverage limits

Example:10000

maximumCoverageDecreaseAmountnumber(double)

The Maximum Coverage Amount Decrease refers to the largest reduction in coverage that a policyholder is allowed to make per policy year, as defined by the insurance carrier. This ensures that policyholders can lower coverage if needed while maintaining a minimum required coverage amount

Example:290000

maximumAgeNumberCoverageAmountDecreaseinteger(int32)

The Maximum Age of No Coverage Amount Decrease refers to the age at which a policyholder can no longer reduce their coverage amount. This limit is set by the insurance carrier to maintain policy integrity and ensure sufficient death benefit protection, particularly for older policyholders

Example:80

coverageAmountDecreaseAllowedinteger(int32)

The Number of Coverage Amount Decrease Allowed Per Policy Year refers to the maximum number of times a policyholder is permitted to reduce their coverage amount within a single policy year. This limit is set by the insurance carrier to maintain policy stability and prevent excessive policy modifications

Example:120

minimumCoverageIncreaseAmountnumber(double)

The Minimum Coverage Amount Increase refers to the smallest increment by which a policyholder can raise their coverage amount within a policy year. This minimum threshold is set by the insurance carrier to ensure that coverage increases are financially viable and align with underwriting guidelines

Example:10000

maximumCoverageIncreaseAmountnumber(double)

The Maximum Coverage Amount Increase refers to the highest amount by which a policyholder can raise their coverage within a single policy year, as defined by the insurance carrier. This limit ensures that coverage increases remain manageable and are aligned with underwriting and financial justification

Example:9700000

maximumAgeNumberCoverageAmountIncreaseinteger(int32)

The Maximum Age of No Coverage Amount Increase refers to the oldest age at which a policyholder can request an increase in coverage. After reaching this age, the policyholder is no longer eligible to increase their coverage amount, as determined by the insurance carrier

Example:80

coverageAmountIncreaseAllowedinteger(int32)

The Number of Coverage Amount Increases Allowed Per Policy Year refers to the maximum number of times a policyholder can request an increase in coverage within a single policy year, as defined by the insurance carrier. This limit helps insurers manage risk exposure and maintain policy stability

Example:10

coverageLayersarray[object]
Show Child Parameters
deathBenefitAmountDistributednumber(double)

The amount of the death benefit that has been paid out. This should be the difference between of Cumulative Gross Death Benefit and Remaining Death Benefit Amount

Example:250000

get/policy/v1/policies/{planCode}/{policyNumber}/coverage
 
application/json

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