Policy Transactions
DeathBenefitOptionChange
objectDeath Benefit Option change request item
requestTypestringrequired
Discriminator identifying this item as a Death Benefit Option change request
Allowed values:DEATHBENEFITOPTIONCHANGE
Example:DEATHBENEFITOPTIONCHANGE
coverageIdstring
Coverage ID received from the policy admin system
Example:Base_Coverage
coverageTypestring
Type of the coverage
Allowed values:BASETERMSUPPLEMENTAL
Example:BASE
deathBenefitOptionstringrequired
New death benefit option elected for the coverage
Allowed values:LEVELINCREASING
Example:LEVEL
deathBenefitComplianceTeststring
IRC compliance test the policy is administered under after the change
Allowed values:GPTCVAT
Example:GPT
Example
BASECOVERAGEUPDATE
objectBase coverage face-amount increase request item
requestTypestringrequired
Discriminator identifying this item as a base coverage face-amount increase
Allowed values:BASECOVERAGEUPDATE
Example:BASECOVERAGEUPDATE
coverageIdstringrequired
Identifier of the coverage whose face amount is being increased
Example:Base_Coverage
coverageTypestringrequired
Type of the coverage
Allowed values:BASETERMSUPPLEMENTAL
Example:BASE
effectiveDatestring(date)
Effective date of the face increase; defaults to the transaction-level effectiveDate when omitted
Example:2026-07-15
faceAmountnumber(double)required
New total face amount for the coverage after the increase
Example:250000
tableRatingsobject
Substandard rating applied as a result of the change, if any
Show Child Parameters
Example
Reclassification
objectRisk-class reclassification request item
requestTypestringrequired
Discriminator identifying this item as a risk-class reclassification
Allowed values:RECLASSIFICATION
Example:RECLASSIFICATION
coverageIdstringrequired
Identifier of the coverage being reclassified
Example:Base_Coverage
effectiveDatestring(date)
Effective date of the reclassification; defaults to the transaction-level effectiveDate when omitted
Example:2026-07-15
coverageTypestringrequired
Type of the coverage
Allowed values:BASETERMSUPPLEMENTAL
Example:BASE
riskClassstringrequired
Risk classification assessed by underwriting
Allowed values:ULTRANONTOBACCOELITENONTOBACCOPREFERREDNONTOBACCOSTANDARDNONTOBACCOSTANDARDTOBACCOSTANDARDAGGREGATESUBSTANDARDNONTOBACCOSUBSTANDARDTOBACCOSTANDARDPLUSNONTOBACCOPREFERREDTOBACCOSTANDARDCONVERSIONNONTOBACCOSTANDARDCONVERSIONTOBACCO
Example:ULTRANONTOBACCO
tableRatingsobject
Substandard rating applied as a result of the change, if any
Show Child Parameters
Example
RiderAdd
objectNew rider addition request item
requestTypestringrequired
Discriminator identifying this item as a new rider addition
Allowed values:RIDERADD
Example:RIDERADD
riderIdstring
Stable unique identifier assigned to this rider, used to target it in a later RIDERUPDATE
Example:Rider_ABRTRM_1
typestringrequired
Rider product/plan code
Allowed values:Rider_OWPRider_ABRTRMRider_CTRRider_ABRCHRRider_ADRRider_WPRRider_CGRRider_GIBRRider_OPRRider_OWDRRider_WDRRider_NHRRider_ABRCRI
Example:Rider_ABRTRM
effectiveDatestring(date)
Effective date of the rider addition; defaults to the transaction-level effectiveDate when omitted
Example:2026-07-15
faceAmountnumber(double)
Face amount of the rider being added; mandatory for face-amount based riders
Example:25000
premiumnumber(double)
Premium associated with the new rider
Example:15
statusstringrequired
Status of the rider being added
Allowed values:ACTIVEPENDINGINACTIVETERMINATE
Example:ACTIVE
optedForPolicystringrequired
Whether the rider election applies at the policy level
Allowed values:YESNO
Example:YES
tableRatingsobject
Substandard rating applied as a result of the change, if any
Show Child Parameters
partyarray[string]required
partyId reference(s) the rider applies to; must reference a party declared in the transaction’s top-level parties array
Example:5f8f2f5c-6c3b-4e3b-8f2f-5c6c3b4e3b8f
Example
RiderUpdate
objectUpdate to an existing rider, including termination — submit status=TERMINATE rather than a separate request type to remove a rider.
requestTypestringrequired
Discriminator identifying this item as an update to an existing rider
Allowed values:RIDERUPDATE
Example:RIDERUPDATE
riderIdstring
Identifier of the specific existing rider instance being updated, as returned/echoed on the originating RIDERADD
Example:Rider_ABRTRM_1
typestringrequired
Rider product/plan code
Allowed values:Rider_OWPRider_ABRTRMRider_CTRRider_ABRCHRRider_ADRRider_WPRRider_CGRRider_GIBRRider_OPRRider_OWDRRider_WDRRider_NHRRider_ABRCRI
Example:Rider_ABRTRM
effectiveDatestring(date)
Effective date of the rider update; defaults to the transaction-level effectiveDate when omitted
Example:2026-07-15
faceAmountnumber(double)
Updated face amount of the rider; mandatory for face-amount based riders, not applicable when status=TERMINATE
Example:25000
premiumnumber(double)
Updated premium associated with the rider; not applicable when status=TERMINATE
Example:15
statusstringrequired
Status of the rider. TERMINATE is also the mechanism for removing a rider — submit this rather than a separate request type
Allowed values:ACTIVETERMINATE
Example:TERMINATE
optedForPolicystring
Whether the rider election applies at the policy level; mandatory unless status=TERMINATE
Allowed values:YESNO
Example:YES
tableRatingsobject
Substandard rating applied as a result of the change, if any
Show Child Parameters
partyarray[string]required
partyId reference(s) the rider applies to; must reference a party declared in the transaction’s top-level parties array
Example:5f8f2f5c-6c3b-4e3b-8f2f-5c6c3b4e3b8f
reasonCodestring
Reason for the rider update, particularly when status=TERMINATE
Allowed values:INSUREDREQUESTREPLACEDNONPAYMENTOTHER
Example:INSUREDREQUEST
Example