Policy Transactions
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
ManageRiderParty
objectA payee or owner party referenced for the rider’s payout (self-serve; party already exists on the policy)
partyRolestring
Maps from the UI Payee field
Allowed values:PAYEEOWNER
Example:PAYEE
partyobject
Show Child Parameters
Example
ManageRiderRequest
objectSelf-serve request body for manage rider eligibility, validation, and submit endpoints
(POST /bpm/v1/policies/{planCode}/{policyNumber}/managerider/eligibilitycheck,
/managerider/validation, and /managerider). Assumes all referenced parties and rider
participants already exist on the policy, identified by partyId only.
correlationIdstring
The unique ID to track transaction request across all systems
Example:e3bdb22b-790f-4357-ae60-42cdb0ff0d12
reverseInitiatorboolean
Property to isolate source transaction(s) that initiated the reversal
Default:false
externalIdentifiersobject
Show Child Parameters
transactionReasonstring
Reason for initiating the manage rider transaction
Allowed values:ONETIMEPREMIUMGRACEPERIODPREMIUMREINSTATEMENTPREMIUMEXCHANGE1035SURRENDERAMOUNTEXCESSTOMECAMOUNTEXCESSTOGUIDELINECURRENTVALUECOSTBASISGUIDELINESINGLEPREMIUMGUIDELINELEVELPREMIUMSEVENPAYPREMIUMTOTALYTDPREMIUMAMOUNTFACEDECREASECOVERAGEINITIALPREMIUMEXPIRATIONCOMPLIANCENOTRANSACTIONREASONSTARTINGPRICELUMPSUMFIVEYEARDEFERRALSPOUSALCONTINUATIONDISCOUNTCONTROLBUSINESSINDICATORNATIONALCHANGEOFADDRESSDATEOFDEATHINITIALDEATHNOTIFICATIONPRODUCTDEFAULTAMOUNTGWBRIDERDISBURSEMENTGWBPHASECHANGEFREQUENCYPREMIUMLOANPAYMENTDUEDATERIDERUPDATEGLWBACTUARIALPRESENTVALUEJUVENILETOADULT
Example:RIDERUPDATEGLWB
ridersarray[object]required
A single rider being added, updated, or removed on the policy
Show Child Parameters
partiesarray[object]
A payee or owner party referenced for the rider’s payout (self-serve; party already exists on the policy)
Show Child Parameters
Example
TaxWithholdingChangeRequest
objectRequest body for tax withholding change (POST /bpm/v1/policies/{planCode}/{policyNumber}/parties/taxwithholding
and validation). Extends transaction case fields with effective date and one or more withholding instruction lines.
planCodestring
Plan code (may duplicate path parameter)
Example:EVIU101
policyNumberstring
Policy number (may duplicate path parameter)
Example:EVIUL7RED012
effectiveDatestring(date)required
Effective date for the tax withholding change
Match pattern:([0-9]{4})-([0-9]{2})-([0-9]{2})
Example:2026-06-17
correlationIdstring(uuid)
The unique ID to track transaction request across all systems
Example:e3bdb22b-790f-4357-ae60-42cdb0ff0d12
carrierIdstring
Carrier identifier
Example:FNWL
caseIdstring
Zinnia Live Case ID
Example:CA0000007389
taxWithholdingInstructionsarray[object]required
Tax withholding instruction lines for the request
>= 1 items
Show Child Parameters
Example
BillingFeatureChangeTransactionReason
stringReason for initiating the billing feature change transaction
Allowed values:AMOUNTFREQUENCYPAYMENTDUEDATE
Example