Search
K
Policy

Rider

object
timestampstring(date-time)

TBD

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

typestring

Allowed values:BASERIDERBASEINCREASEINTEGRATEDRIDERRIDERINCREASEBENEFITDISCOUNTOTHERUNKNOWN

riderNamestring

The specific name of the rider as designated by the insurance company. For example - Terminal Illness Accelerated Death Benefit

Example:Chronic Illness Accelerated Death Benefit Rider

riderElectedstring

Indicates the election status of the rider on the policy, specifying whether the policyholder has formally elected to include the rider

Example:ELECTED

riderCodestring

A unique identifier or alphanumeric code assigned to the rider

Example:SBLCHR

underwritingStatusstring

Allowed values:APPROVEDDECLINED

unbornChildIndicatornumber

This will be set to yes if there is no Child rider insured to support Unborn Child

Allowed values:true

qualifiedAdditionalBenefitnumber

Indicates whether the rider provides a qualified benefit under IRS or insurance regulations

Allowed values:true

effectiveDatestring(date)

Date on which Rider is selected and becomes effective on the policy

Example:2023-01-01

exerciseDatestring(date)

The date the policyholder elects to use or activate the rider benefit

Example:2023-01-01

terminationDatestring(date)

The date on which the rider coverage ends/ is terminated

Example:2023-01-01

statusstring

Allowed values:ACTIVETERMINATEDPENDINGSUSPENDED

coverageIdstring

An unique identifier assigned to the rider coverage within an insurance coverage or policy layer

Example:Rider_SBLCHR

amountnumber

The total benefit amount the rider provides (separate from the base policy’s coverage.)

annualBenefitAmountnumber(double)

The maximum benefit amount of the benefit base, policyholder can withdraw each year

riderBenefitAmountnumber(double)

The Total Benefit Amount represents the maximum guaranteed amount available under the annuity rider over the life of the contract/rider

riderBenefitPercentnumber(double)

The fixed percentage applied to the Rider Benefit Amount to calculate the annual guaranteed benefit amount

Example:100

minimumRiderBenefitAmountnumber(double)

Refers to a guaranteed payout to a beneficiary upon the death of the annuitant, regardless of the contract investment performance, as long as the annuity is in the accumulation phase. Used for Variable annuities

growthIncomeBenefitAmountnumber(double)

The Growth Income Benefit value represents the guaranteed income base established under a Guaranteed Minimum Income Benefit (GMIB) rider. It is used to calculate the lifetime income payments the annuitant is entitled to upon annuitization, regardless of the contract actual account value.

riderStoredIncomeBalancenumber(double)

Amount that can be withdrawn without reducing the yearly or Lifetime rider benefit amount

riderParticipantarray[object]

Note - Use riderParticipants field instead of riderParticipant

Show Child Parameters
riderParticipantsarray[object]
Show Child Parameters
chargeobject
Show Child Parameters
maximumChronicIllnessBenefitPercentagenumber

The highest percentage of the death benefit or face amount that can be taken for chronic illness coverage

Example:2.5

maximumPeriodicPaymentPeriodnumber

The maximum duration over which payments can be made under the rider ( in Months)

claimStatusnumber

The current status of a claim filed under the rider

Allowed values:true

nextEvaluationDatestring(date)

The date of the next scheduled review or re-evaluation of an ongoing claim (applicable for riders like chronic illness).

Example:2023-01-01

riderPaymentDatestring(date)

The date the benefit payout under the rider is to be disbursed to the policyholder or beneficiary

Example:2023-01-01

terminalRiderPaymentAmountnumber

The amount paid under the rider benefit.(during a given payout cycle)

riderMinimumPaymentAmountnumber

Deprecated - kept for backwards compatibility

maximumCriticalIllnessBenefitPercentagenumber

The highest percentage of the policy’s face amount that can be accessed under the critical illness rider

tierOneMaximumCriticalIllnessBenefitPercentagenumber

The percentage of the benefit payable under Tier 1 of the critical illness structure (e.g., for mild conditions).

tierOneMaximumCriticalIllnessBenefitAmountnumber

The maximum dollar amount payable under Tier 1 benefits

tierTwoMaximumCriticalIllnessBenefitPercentagenumber

The percentage of the benefit payable under Tier 2(usually for more severe conditions.)

tierTwoMaximumCriticalIllnessBenefitAmountnumber

The maximum dollar amount payable under Tier 2 benefits.

tierOneCriticalRiderPaymentDatestring(date)

The date on which the Tier 1 critical illness rider benefit payment is scheduled or was made

Example:2023-01-01

tierOneCriticalRiderPaymentAmountnumber

The amount of benefit paid under the Tier 1 critical illness

tierTwoCriticalRiderPaymentDatestring(date)

The date on which the Tier 2 critical illness rider benefit payment is scheduled or was made

Example:2023-01-01

tierTwoCriticalRiderPaymentAmountnumber

The amount of benefit paid under the Tier 2 critical illness

coverageLayersarray[object]
Show Child Parameters
remainingBenefitnumber(double)

The remaining benefit amount for the rider. Incremented by Premiums and adjusted by withdrawals.

Example:10.51

additionalBenefitUsedUpnumber

Indicates whether the ADL benefit is utilised on the contract.

Allowed values:true

totalBenefitnumber(double)

The total guaranteed value the contract owner is entitled to at the end of the GMAB holding period — assuming no disqualifying withdrawals or events.

Example:5.17

payoutOptionstring

Single or Joint Payout (not driven by Owners on the policy, even a jointly owned policy can have single as an option. Used in configuration to set different GMWB benefits for Single and Joint GMWB Amount Types

Allowed values:SINGLEJOINT

benefitPercentnumber(double)

Ties to Withdrawal Reset Benefit % Annual Limit on Calender Processing if GMWB Anniversary Base reset is elected. Equals result of GMWB Benefit % equation box in Withdrawal tab (GMWB) Ku - Payout Factor Percentage of the benefit base that will be available for withdrawal each year

Example:1.23

annualBenefitLimitnumber(double)

GMWB Annual Limit, The total amount that can be withdrawn as a benefit of this rider in any given policy year, regardless of whether or not there is sufficient account value. It is also the annual limit on amounts that can be withdrawn without adversely affecting future annual and lifetime benefits from the rider.this amount will be impacted during Reset or Withdrawals or Premium events

Example:3.43

currentAnnualLimitnumber(double)

GMWB Annual Limit, The total amount that can be withdrawn as a benefit of this rider in any given policy year, regardless of whether or not there is sufficient account value. It is also the annual limit on amounts that can be withdrawn without adversely affecting future annual and lifetime benefits from the rider.this amount will be impacted during Reset or Withdrawals or Premium events

Example:5.45

remainingAnnualLimitnumber(double)

The GMWB amount still available for withdrawal in the current Contract Year without creating an “Excess Withdrawal” situation.

Example:6.75

hypotheticalAnnualLimitnumber(double)

During the riders accumulation phase (before it is exercised), a hypothetical annual withdrawal limit is calculated and displayed on statements to inform the policyholder and assist in their decision to exercise the rider

Example:8.95

phasestring

Indicator for whether the phase is Accumulation (not activated, benefit base is still accruing) or Income (annual limit calculated, benefit bases stop growing). Default value = Accumulation

Allowed values:ACCUMULATIONINCOME

lastResetDatestring(date)

User initiates the Reset, Variables product

Example:2023-01-01

baseobject
Show Child Parameters
Example

PolicyChargeType

string

Allowed values:COSTOFINSURANCEEXPENSECHARGEUNITEXPENSECHARGEPAYMENTCHARGECOVERAGECHARGECOVERAGECREDITPREMIUMTAXSURRENDERCHARGEMARKETVALUEADJUSTMENTRIDERCHARGE

PolicyCharges

object
chargeTypestring

Allowed values:COSTOFINSURANCEEXPENSECHARGEUNITEXPENSECHARGEPAYMENTCHARGECOVERAGECHARGECOVERAGECREDITPREMIUMTAXSURRENDERCHARGEMARKETVALUEADJUSTMENTRIDERCHARGE

coverageIdstring

The Coverage ID is a unique identifier assigned to a specific coverage component within a life insurance or annuity policy, used to track the specific coverage for which charges are being applied. It ensures that the correct charges (e.g., cost of insurance, rider fees, administrative fees) are linked to the appropriate coverage layer.This is optional field which will be populated by LPS

Example:Base_Coverage

currentMonthChargenumber(double)

The Current Month Charge refers to the total amount deducted from a life insurance or annuity policy for the current billing period, covering various costs such as insurance charges, administrative fees, rider costs, and investment-related expenses

Example:123.12

uncollectedPerChargenumber(double)

The Uncollected Per Charge refers to the portion of a scheduled charge that has not been paid or deducted from the policy due to insufficient funds, unpaid premiums, or cash value shortfall. This can apply to Cost of Insurance (COI), rider fees, administrative charges, or investment-related expenses

Example:10.42

cumulativePerChargenumber(double)

The Cumulative Per Charge refers to the total sum of a specific charge type from the policy`s issue date until the current processing date. It provides a historical record of charges deducted over the life of the policy… Calculated by LPS.

Example:721.42

Example

ArrangementType

string

Allowed values:PAYMENTWITHDRAWALLOANREPAYMENTREQUIREDMINIMUMDISTRIBUTIONPAYOUT

AllocationOption

string

Allowed values:PRORATADOLLARSPECIFYPERCENTAGESPECIFIEDFUNDSSPECIFIEDSEGMENTSDEFAULTPECKINGORDEREARNINGSONLY