Policy Transactions

Zinnia Policy Transactions API.

ManageRiderPartyAddress

object

Reference to an existing policy address by addressId (self-serve)

addressIdstring

Example:Address_PI_1

Example

ManageRiderPartyBankDetails

object

Reference to an existing policy bank record by bankId (self-serve)

bankIdstring

Example:Bank_PI_1

Example

ManageRiderPartyDetails

object
partyIdstring

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

object

A 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

object

Self-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