Policy Transactions
PolicyCoverageChangesExternalIdentifiers
objectexternalTransactionIdstring
Transaction identifier assigned by the external/source system submitting the request
Example:test
referenceNumberstring
Additional reference number supplied by the external system for tracking purposes
Example:uniquetest1233
Example
PolicyCoverageChangesRequestItem
objectA single policy-update request item. The shape of the remaining properties depends on requestType.
One OfrequestTypestringrequired
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
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