Policy Transactions

Zinnia Policy Transactions API.

ManageRiderParticipantParty

object

Reference to an existing policy party by partyId (self-serve)

partyIdstring

Example:Party_PI_1

Example

ManageRiderParticipant

object

A single rider participant (Covered / Joint Covered party)

partyRolestring

Role of the party participating in the rider

Allowed values:JOINTINSUREDCOVERAGEINSURED

Example:COVERAGEINSURED

partyobject

Reference to an existing policy party by partyId (self-serve)

Show Child Parameters
Example

ManageRiderPaymentFrequency

string

Maps from the UI Payment Frequency field

Allowed values:MONTHLYQUARTERLYBIANNUALLYANNUALLY

Example

ManageRiderAmountBasis

string

Basis used to determine the payout amount

Allowed values:MAXIMUMANNUALBENEFITSPECIFIEDAMOUNTSPECIFIEDPERCENTAGEREQUIREDMINIMUMDISTRIBUTION

Example

ManageRiderPayoutDetails

object
paymentFrequencystring

Maps from the UI Payment Frequency field

Allowed values:MONTHLYQUARTERLYBIANNUALLYANNUALLY

Example:MONTHLY

paymentStartDatestring(date)

Maps from the UI Payment Start Date field

Example:2026-07-31

amountBasisstring

Basis used to determine the payout amount

Allowed values:MAXIMUMANNUALBENEFITSPECIFIEDAMOUNTSPECIFIEDPERCENTAGEREQUIREDMINIMUMDISTRIBUTION

Example:MAXIMUMANNUALBENEFIT

specifiedAmountnumber
specifiedPercentagenumber
currencyCodestring

Example:USD

excessWithdrawalConsentboolean
Example