Policy Transactions
PartyDetailsForPartyRole
objectFull party detail payload (pa-bpm-txn-common PartyDetailsForPartyRoleDto).
Only the fields relevant to the action/party role need to be populated.
startDatestring(date)
endDatestring(date)
timestampstring
customerIdstring
partyIdstring
Party identifier. Required for UPDATE/DELETE actions; omit (or leave
null) for ADD so the carrier assigns one. Defaults to a random UUID
client-side if not explicitly set - always set explicitly for
UPDATE/DELETE.
parentPartyIdstring
Parent party identifier (e.g. for a minor’s guardian relationship)
partyTypestring
partyStatusstring
beneficiaryPercentageinteger
firstNamestring
middleNamestring
lastNamestring
fullNamestring
prefixstring
suffixstring
genderstring
genderIdentitystring
dateOfBirthstring(date)
attainedAgeinteger
birthCountrystring
citizenCountrystring
birthStatestring
doingBusinessAsstring
abbreviatedNamestring
organizationCodestring
entityTypestring
trustDatestring(date)
trustTypestring
trustTitlestring
trustAccessCodestring
amendedTrustDatestring(date)
governingStateOfTruststring
preferredCommunicationTypestring
preferredAddressIndicatorstring
identificationsarray[object]
Show Child Parameters
addressesarray[object]
Show Child Parameters
phonesarray[object]
Show Child Parameters
emailsarray[object]
Show Child Parameters
bankDetailsarray[object]
Bank details associated with a party
Show Child Parameters
versionstring
agentExternalIdstring
agentTypestring
agentPercentagenumber(double)
partyPercentagenumber(double)
collateralAmountnumber(double)
deathDetailsobject
Show Child Parameters
impairmentDetailsobject
Show Child Parameters
isPartyBeneficiaryNonNaturalboolean
isIrrevocableboolean
isRequiredMinimumDistributionDesignatedboolean
preferredAddressIdstring
preferredEmailIdstring
preferredPhoneIdstring
isAddressSameAsOwnerstring
Example
PartyUpdate
objectA single party change entry (pa-bpm-txn-common PartyUpdateDto). One
MultiPartyRoleChangeRequest carries a list of these - one per party being
added, updated, or removed in this transaction.
actionstringrequired
Action to apply for this party update entry
Allowed values:ADDUPDATEDELETENONE
Example:ADD
customerIdstring
Top-level customer ID. Sent alongside party.customerId for the same party.
relationshipToPartystring
partyRolestring
The specific party role for this entry. Each backing microservice sends
its own literal value today, with no shared casing convention across
services (tracked for future normalization): PAYEE (payee-change),
TRUSTEE (trustee-change), ATTORNEY_IN_FACT (poa-change),
AuthorizedSignatory (authorized-signatory-change), Owner / JointOwner
(owner-mgmt), CoverageJointInsured (rider-role-change).
Example:CoverageJointInsured
referencePartyIdstring
PartyId of an existing party on the policy to clone when adding a new
party (e.g. ADD a new Coverage Joint Insured with the same details as
an existing party). Only relevant for action ADD; not forwarded to
downstream carrier systems.
partyStatusstring
carrierDecisionstring
rejectionReasonstring
delegatedExecutionAuthorityTypestring
Power of Attorney specific - delegated execution authority type
powerOfAttorneyAccessLevelTypestring
Power of Attorney specific - access level type
partyobject
Full party detail payload (pa-bpm-txn-common PartyDetailsForPartyRoleDto).
Only the fields relevant to the action/party role need to be populated.
Show Child Parameters
Example
MultiPartyRoleChangeRequest
objectGeneric request body for a party role change transaction (pa-bpm-txn-common
MultiPartyRoleChangeRequest), shared across all multi-party-update
transactions (Payee, Trustee, Power of Attorney, Owner/Joint Owner,
Authorized Signatory, Coverage Joint Insured, and future party roles).
Each party role is exposed at its own dedicated path (see the
…/parties/{role}/… operations); this schema is the shared contract
across all of them.
planCodestring
Plan code (may duplicate path parameter)
policyNumberstring
Policy number (may duplicate path parameter)
caseIdstring
Zinnia Live Case ID
Example:CA0000007389
correlationIdstring
The unique ID to track transaction request across all systems
Example:e3bdb22b-790f-4357-ae60-42cdb0ff0d12
carrierIdstring
Carrier identifier
Example:FNWL
effectiveDatestring(date)required
Effective date for the party role change
Example:2026-07-24
requestSourcestring
Origin of the request
Allowed values:DATA_ENTRYSELF_SERVE
partyUpdatesarray[object]required
A single party change entry (pa-bpm-txn-common PartyUpdateDto). One
MultiPartyRoleChangeRequest carries a list of these - one per party being
added, updated, or removed in this transaction.
>= 1 items
Show Child Parameters
signaturesarray[object]
Signature details for the agent change
Show Child Parameters
documentsarray[object]
Supporting document reference for a party role change
Show Child Parameters
selfServeFlowboolean
Whether the request originated from a self-serve flow
Example:true
supportingDocumentAttachedboolean
Indicates whether supporting documents are attached
Example:true
changeReasonstring
Reason for the change
Example
ReinstatementQuoteRequest
objectcorrelationIdstringrequired
The unique ID to track transaction request across all systems
Example:657b717b7dcf554abf9ef067
effectiveDatestring(date)required
Date when the transaction was originally scheduled or expected to happen. It can be a non-business day
Example:2023-01-01
reverseInitiatorboolean
Property to isolate source transaction(s) that initiated the reversal
Default:false
externalIdentifiersobject
Show Child Parameters
policyobjectrequired
Show Child Parameters
Example
ReinstatementRequest
objectcorrelationIdstringrequired
The unique ID to track transaction request across all systems
Example:657b717b7dcf554abf9ef067
effectiveDatestring(date)required
Date when the transaction was originally scheduled or expected to happen. It can be a non-business day
Example:2023-01-01
reverseInitiatorboolean
Property to isolate source transaction(s) that initiated the reversal
Default:false
policyobjectrequired
Show Child Parameters
transactionAmountsobjectrequired
Show Child Parameters
systematicProgramobjectrequired
Show Child Parameters
caseIdstringrequired
Zinnia Live Case ID
Example:CA0000007389
Example