IriRiderCharge
objectOne-time rider charge applied upon rider activation/exercise.
>= 0<= 9999999999.99
The rate or percentage applied to calculate the charge for exercising the rider.
>= 0<= 9999999999.99
IriLivesType
stringIndicates whether the rider covers single, joint, or multiple lives.
Allowed values:SINGLEJOINTMULTIPLEUNKNOWN
IriPolicyRider
objectCreate or update timestamp of the rider record.
Example:2026-03-06T12:00:00Z
Classification of the rider.
Allowed values:BASERIDERINTEGRATED_RIDERBENEFIT_RIDERINCOME_RIDERDEATH_BENEFIT_RIDERLTC_RIDERGMWB_RIDERGMDB_RIDERGMAB_RIDERCHARGE_RIDERDISCOUNTBASE_INCREASERIDER_INCREASEOTHERUNKNOWN
The specific name of the rider as designated by the carrier.
<= 200 characters
Example:Guaranteed Lifetime Withdrawal Benefit
Whether the policyholder has formally elected to include the rider on the policy.
Example:true
A unique identifier or alphanumeric code assigned to the rider.
Match pattern:^[A-Za-z0-9._-]{1,100}$
Example:GLWB
Underwriting decision for the rider.
Allowed values:APPROVEDDECLINED
Date on which the rider is selected and becomes effective on the policy.
Example:2022-01-15
The date the policyholder elects to use or activate the rider benefit.
Example:2023-01-01
The date on which the rider coverage ends or is terminated.
Example:2023-01-01
The date the benefit payout under the rider is to be disbursed.
Example:2023-01-01
Current status of the rider.
Allowed values:ACTIVETERMINATEDPENDINGSUSPENDED
A unique identifier assigned to the rider coverage within an insurance coverage or policy layer.
Match pattern:^[A-Za-z0-9._-]{1,100}$
Example:Rider_GLWB
The total benefit amount the rider provides.
>= 0<= 9999999999.99
Example:250000
The maximum benefit amount of the benefit base the policyholder can withdraw each year.
>= 0<= 9999999999.99
The maximum guaranteed amount available under the annuity rider over the life of the contract/rider.
>= 0<= 9999999999.99
The fixed percentage applied to the rider benefit amount to calculate the annual guaranteed benefit amount.
>= 0<= 100x 0.01
Example:100
The remaining benefit amount for the rider, incremented by premiums and adjusted by withdrawals.
>= 0<= 9999999999.99
Example:10.51
The total guaranteed value the contract owner is entitled to under the rider.
>= 0<= 9999999999.99
Example:5.17
The total amount that can be withdrawn as a benefit of this rider in any given policy year.
>= 0<= 9999999999.99
Example:3.43
Percentage of the benefit base that will be available for withdrawal each year.
>= 0<= 100x 0.01
Example:1.23
Single or Joint payout option for the rider.
Allowed values:SINGLEJOINT
The highest percentage of the death benefit or face amount that can be taken for chronic illness coverage.
Example:2.5
The maximum duration, in months, over which payments can be made under the rider.
Example:60
Participants (insureds) covered under the rider.
Show Child Parameters
Show Child Parameters
Indicates whether the additional benefit under the rider has been used up.
Further classification of the rider sub-type.
Match pattern:^[A-Za-z0-9._ -]{1,100}$
<= 100 characters
Indicates whether the rider covers single, joint, or multiple lives.
Allowed values:SINGLEJOINTMULTIPLEUNKNOWN
Whether the rider participant designation is irrevocable.
Additional classification detail for the rider.
Match pattern:^[A-Za-z0-9._ -]{1,100}$
<= 100 characters
Free-of-charge amount available under the rider.
>= 0<= 9999999999.99
Role code of the rider participant.
Match pattern:^[A-Za-z0-9._ -]{1,100}$
<= 100 characters
IriPolicyRiders
objectUsed for pagination to indicate where the returned page starts within the full result set.
>= 0
Number of records included in the current response page.
>= 0
Example:1
Total number of records available that match the request criteria, independent of pagination.
>= 0
Example:1
Riders associated with the policy.
Show Child Parameters
IriTransactionType
stringSpecifies the type of transaction being performed, such as Premium Payment, Loan Repayment, Anniversary etc
Allowed values:SubsequentPaymentOneTimePremiumPartialWithdrawalOneTimeSystematicPartialWithdrawalRequiredMinimumDistributionOneTimeSystematicRequiredMinimumDistributionFullSurrenderFundTransferFundAllocationsChangeSweepDollarCostAverageNewLoanLoanRepaymentOneTimeSystematicLoanRepaymentAnnuitizationSystematicAnnuityPayoutPayoutAmountChangeServiceChargeRiderChargeValueAdjustmentInterestCreditAddressChangeEmailChangePhoneNumberChangeBeneficiaryChangeOwnerChangeBankAccountChangeCommunicationPreferenceChangeReinstatementLapseOther