Search
K
Policy

Rate

object
rateTypestring

Rate Type identifies the classification of the rate that is being applied to a specific fund or account value within a life insurance or annuity policy. It defines how the interest, return, or crediting rate is determined for that fund.It helps dictate whether the rate is fixed, variable, index-linked, declared, or derived from another methodology, and plays a key role in calculating earnings or charges associated with the fund.

Allowed values:PARTICIPATIONCAPSPREADTRIGGERFLOORBONUSGMIRILLUSTRATIONTHRESHOLDFUNDFEEBAILOUTBUFFERCOUPON

currentRatenumber(double)

Current Rate refers to the actual interest rate or crediting rate being applied to a specific fund or account at the present time, as declared or calculated by the insurance carrier. It is used to determine how much interest or investment return will be credited to the contract or sub-account during the current crediting period.

Example:33.28

initialGuaranteeRatenumber(double)

The Initial Guaranteed Rate is the fixed interest rate promised by the insurance carrier at the start of the contract or fund allocation, which is guaranteed not to change for a specified initial period (e.g., 1, 3, 5, or 10 years), depending on the product terms.

Example:33.28

guaranteedMinimumInterestRatenumber(double)

The Guaranteed Minimum Rate is the lowest interest rate that an insurance company is legally or contractually obligated to credit to the account value or specific fund of a life insurance or annuity policy—regardless of market performance or declared rates. This rate acts as a floor, providing downside protection for the policyholder by ensuring a minimum return is always credited to the contract.

Example:33.28

Example

FundSegment

object
segmentIdstring

A unique identifier assigned to a particular investment segment or bucket

Example:3

fundIdstring

A unique identifier assigned to a specific fund account within the investment structure

Example:FundAccount1

originalDepositAmountnumber(double)

The initial amount deposited to the fund segment

Example:5.22

originalDepositDatestring(date)

The date on which the original deposit was deposited into the fund segment.(date the segment created)

Example:2023-01-01

depositDatestring(date)

The date on which the additional deposit was deposited into the fund segment

Example:2023-01-01

depositAmountnumber(double)

The additional amount deposited to the fund segment

Example:5.22

currentAmountnumber(double)

The value of the specific fund account segment, including all contributions, interest, and market changes

Example:161.81698

renewalDatestring(date)

The date on which the segment may be renewed or reinvested

Example:2023-01-01

numberOfUnitsnumber(int32)

The number of units allocated in the fund segment (applicable to variable investments).

Example:50

sweepAccountIdstring

The designated account where the segment funds will be transferred upon sweep,maturity

Example:ELI002

interestEarningAmountnumber(double)

This amount is used for Index interest calculation when Index crediting method is “averaging”

Example:161.81698

appliedInterestRatenumber(double)

The interest rate used to calculate interest amount for segment as of the last transaction

Example:161.81698

startingPricenumber(double)

The initial market/index price or unit value when the segment was created

Example:1234.21321

startingPriceDatestring(date)

Date of Starting Price to be used for Index

Example:2023-01-01

endingPricenumber(double)

The market/index price or unit value when the segment was matures/ends

Example:2000.81698

endingPriceDatestring(date)

The date on which the ending price was determined

Example:2023-01-01

indexChangeRatenumber(double)

The Index Change Rate refers to the rate of change in the value of an external market index (such as the S&P 500, Nasdaq, etc.) that is used to calculate interest credits for an indexed insurance or annuity product. It represents the percentage increase or decrease in the selected index over a defined crediting period, and directly influences the policy’s credited interest or return.

Example:2000.81698

startDatestring(date)

The date when the segment gets created

Example:2023-01-01

endDatestring(date)

The date when the segment matures/ends

Example:2023-01-01

maxPricenumber(double)

Deprecated - kept for backward compatibility. Max Price = Max (IQ1, IQ2, IQ3, IQ4, …. IQN). where IQ1 denotes the index value at the 1st Quarterversary of the contract, IQ2 denotes the index value at the 2nd Quarterversary of the contract and so on and IQN denotes the index value at the end of the guarantee period (N=4*Guarantee period of the fund)

Example:1234.21321

maxPriceDatestring(date)

Deprecated - kept for backward compatibility. The corresponding date of the determined Quarterversary

Example:2023-01-01

ratesarray[object]

Array of rates associated with this fund segment

Show Child Parameters
Example

Fund

object
fundAccountTypestring

Allowed values:FIXEDINDEXEDVARIABLEINTERIM

fundIdstring

A unique identifier assigned to a specific fund account within the investment structure

Example:ELI002

fundNamestring

The official business name of the specific fund account within the investment structure

Example:S&P 500® Price Return Annual Point-to-Point with Participation Rate Account

generalLedgerFundCodestring

The accounting code used in the insurer’s general ledger for tracking fund transactions

Example:XE2

totalFundValuenumber(double)

The total value of the specific fund account within the investment structure.The total fund value of the a specific fund, considering any earnings, withdrawals, or adjustments due to transaction

Example:15.67

percentageOfAccountValuenumber(double)

Percentage of Account Value refers to a value that is calculated as a percentage of the total account value of an insurance or annuity contract. It is often used to determine allocations, fees, benefits, or charges that are based on how much money is currently held in the policy’s account value.

Example:13.27

interestGuaranteedPeriodnumber(int32)

The length of time for which the guaranteed minimum interest rate is applicable

Example:3

guaranteedMinimumInterestRatenumber(double)

Retrieving data. Wait a few seconds and try to cut or copy again

Example:1.52

fundSegmentsarray[object]
Show Child Parameters
Example

MatchSegment

object
segmentIdstring

TBA unique identifier assigned to a specific match segment within the policy, used to track matched contributions or benefits

Example:Match1

matchAccountValuenumber(double)

The present value of the matched amount/bonus in the segment, reflecting any growth, deductions, or adjustments

Example:1.985116

cumulativeMatchPaymentAmountnumber(double)

The total amount of matching contributions or eligible bonus contributions accumulated over time within the policy

Example:1.98

yearToDateMatchValuenumber(double)

The amount of matching contributions or eligible bonus contributions accumulated over the current policy year

Example:1.98

maximumLifeTimeVestingAmountnumber(double)

The highest total amount that can be matched or highest total eligible bonus over the lifetime of the policy, as per policy terms

Example:300

maximumAnnualVestingAmountnumber(double)

The maximum amount that can be matched or eligible bonus for current policy year

Example:300

minimumPaymentsForMatchnumber(double)

The minimum amount that can be matched or minimum eligible bonus over the lifetime of the policy, as per policy terms

unvestedPremiumBonusnumber(double)

This is the current value that is not fully vested to the policy holder. It would be recaptured partially/fully at withdrawal/surrender.

Example:10.12

totalRecapturedPremiumBonusnumber(double)

The total amount of the premium bonus that was deducted from the policy value as a result of a partial or full withdrawal during the vesting period.

Example:10.12

matchVestingDatestring(date)

The date on which the matched amount/ bonus becomes fully vested, meaning the policyholder gains full ownership rights over the matched funds/bonus.(match amount/bonus becomes part of account value)

Example:2023-01-01

generalLedgerFundCodestring

The accounting code used in the insurer’s general ledger system to track match/bonus related transactions

Example:V2201

vestingPeriodnumber(int32)

The duration required before matched amount/bonus are fully vested, typically expressed in years or policy terms

Example:10

Example

LoanType

string

Allowed values:PREFERREDNONPREFERREDSTANDARDLOANINDEXLOAN