Policy Transactions
ManageRiderRider
objectA single rider being added, updated, or removed on the policy
actionstring
Action to perform for this rider entry
Allowed values:ADDUPDATEDELETENONE
Example:UPDATE
riderIdstring
Example:Rider_1
riderCategorystring
Category of the rider
Allowed values:BENEFITDISCOUNTOTHERRIDERUNKNOWN
Example:RIDER
riderTypestring
Type of rider being managed
Allowed values:GLWBGMWBGMIBGMABGMDBRETURNOFPREMIUMENHANCEDDEATHBENEFITINCOMEACCELERATORNURSINGHOMEWAIVERTERMINALILLNESSWAIVEROFPREMIUMACCIDENTALDEATHBENEFITCHILDTERMSPOUSETERMTERMRIDERGUARANTEEDINSURABILITYACCELERATEDDEATHBENEFITLONGTERMCAREOVERLOANPROTECTIONPAIDUPADDITIONS
Example:GLWB
optedForPolicystring
Whether the rider is opted for on the policy
Allowed values:YESNO
Example:YES
effectiveDatestring(date)
Example:2026-07-15
exerciseDatestring(date)
Maps from the UI Exercise Date field
Example:2026-10-29
riderStatusstring
Example:ACTIVE
payoutOptionstring
Maps from the UI Withdrawal Option field
Allowed values:SINGLEJOINT
Example:SINGLE
unbornChildIndicatorboolean
additionalBenefitClaimRequestedboolean
faceAmountnumber
Example:25000
premiumnumber
Example:25000
riderParticipantsarray[array]
Maps from the UI Covered / Joint Covered Info fields. Each entry is a group of participants for the rider.
payoutDetailsobject
Show Child Parameters
tableRatingsobject
Show Child Parameters
Example
ManageRiderPartyRole
stringMaps from the UI Payee field
Allowed values:PAYEEOWNER
Example
ManageRiderPartyAddress
objectReference to an existing policy address by addressId (self-serve)
addressIdstring
Example:Address_PI_1
Example
ManageRiderPartyBankDetails
objectReference to an existing policy bank record by bankId (self-serve)
bankIdstring
Example:Bank_PI_1
Example
ManageRiderPartyDetails
objectpartyIdstring
Example:Party_PI_1
partyPercentagenumber
Example:100
paymentFormstring
Mode of payment
Allowed values:DTCCCREDITCARDACHCHECKWIREEXCHANGEEFT
addressesarray[object]
Reference to an existing policy address by addressId (self-serve)
Show Child Parameters
bankDetailsarray[object]
Reference to an existing policy bank record by bankId (self-serve)
Show Child Parameters
Example