Policy Transactions

Submit Coverage Joint Insured Role Change

Submits the Coverage Joint Insured role change transaction for processing.
Generic Party Role Change endpoint, shared across all multi-party-update transactions (Payee, Trustee, Power of Attorney, Owner, Joint Owner, Authorized Signatory, Coverage Joint Insured, and future party roles using the same MultiPartyRoleChangeRequest/PartyUpdate request format).

post

Path Parameters

planCodestringrequired

Plan Code

policyNumberstringrequired

Policy Number

Body

application/json

MultiPartyRoleChangeRequest

Generic 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

Response

application/json

Submit Transaction Successful

TransactionAcceptedResponse

correlationIdstring

Unique identifier which used by every system to trace the request

Example:3a2a3435-2089-4b81-9959-e0d569ccf4f0

caseIdstring

Zinnia Live Case ID

Example:CA0000369469

caseStatusstring

Zinnia Live Case Status

Example:IN_PROGRESS

pdfIdstring

Identifier for the generated or associated PDF document (e.g. OnBase document number). Returned on systematic program setup and update submit when available.

Example:DOC-10004567

post/policy/v1/transactions/{planCode}/{policyNumber}/parties/CoverageJointInsured

Body

{ "correlationId": "e3bdb22b-790f-4357-ae60-42cdb0ff0d12", "planCode": "EVGFIA909", "policyNumber": "EVFIA095509100", "effectiveDate": "2026-07-24", "requestSource": "DATA_ENTRY", "partyUpdates": [ { "action": "ADD", "partyRole": "CoverageJointInsured", "party": { "firstName": "John", "lastName": "Doe", "dateOfBirth": "1980-05-12", "gender": "M" } } ] }
 
application/json

Freelook cancellation request

If freelook endDate is less than or equal to policy effective Date, cancel the policy based on the request

post

Path Parameters

planCodestringrequired
policyNumberstringrequired

Policy Number

Body

application/json

FreeLookCancellationRequest

correlationIdstring

The unique ID to track transaction request across all systems

Example:657b717b7dcf554abf9ef067

effectiveDatestring(date)required

Date (with pattern “yyyy-mm-dd”)

Match pattern:([0-9]{4})-([0-9]{2})-([0-9]{2})

transactionAmountsobjectrequired
Show Child Parameters
payeeOrBeneficiaryobject
Show Child Parameters
partiesarray[object]required
Show Child Parameters
reverseInitiatorboolean

Property to isolate source transaction(s) that initiated the reversal

caseIdstring

Zinnia Live Case ID

Example:CA0000007389

Response

application/json

Success

TransactionAcceptedResponse

correlationIdstring

Unique identifier which used by every system to trace the request

Example:3a2a3435-2089-4b81-9959-e0d569ccf4f0

caseIdstring

Zinnia Live Case ID

Example:CA0000369469

caseStatusstring

Zinnia Live Case Status

Example:IN_PROGRESS

pdfIdstring

Identifier for the generated or associated PDF document (e.g. OnBase document number). Returned on systematic program setup and update submit when available.

Example:DOC-10004567

post/policy/v1/transactions/{planCode}/{policyNumber}/freelookcancellation

Body

{ "effectiveDate": "effectiveDate", "transactionAmounts": { "disbursementType": "GROSS", "disbursementPaymentForm": "DTCC" }, "parties": [ { "partyId": "Party_PI_1", "paymentForm": "DTCC", "allocationPercentage": 100 } ] }
 
application/json

Eligibility Check to Set Delivery Date

post

Path Parameters

planCodestringrequired
policyNumberstringrequired

Body

application/json

SetDeliveryDateEligibilityRequest

correlationIdstring

Example:864e43a0-2c2f-4a11-9d7f-69ed40115066

taxIdstring

Example:666911019

documentTypestring

Example:POLPG

Response

application/json

Success

TransactionResponse

statusstring

Allowed values:successfailure

errorarray[object]
Show Child Parameters
quoteResponseobject
post/policy/v1/transactions/{planCode}/{policyNumber}/deliverydatesetup/eligibilitycheck

Body

{}
 
application/json

Set Delivery Date Transaction

post

Path Parameters

planCodestringrequired
policyNumberstringrequired

Body

application/json

SetDeliveryDateRequest

correlationIdstring

Example:864e43a0-2c2f-4a11-9d7f-69ed40115066

taxIdstring

Example:666911019

documentTypestring

Example:POLPG

acknowledgementDatestring(date-time)
reverseInitiatorboolean

Property to isolate source transaction(s) that initiated the reversal

Response

application/json

Success

TransactionAcceptedResponse

correlationIdstring

Unique identifier which used by every system to trace the request

Example:3a2a3435-2089-4b81-9959-e0d569ccf4f0

caseIdstring

Zinnia Live Case ID

Example:CA0000369469

caseStatusstring

Zinnia Live Case Status

Example:IN_PROGRESS

pdfIdstring

Identifier for the generated or associated PDF document (e.g. OnBase document number). Returned on systematic program setup and update submit when available.

Example:DOC-10004567

post/policy/v1/transactions/{planCode}/{policyNumber}/deliverydatesetup

Body

{}
 
application/json

EDelivery Enrollment

post

Path Parameters

planCodestringrequired
policyNumberstringrequired

Body

application/json
idstring

preferenceId (should be null for preference creation)

Example:e22cd4aee27d34c9b7c748d50e558b41

carrierIdstringrequired

carrier id for policy

Example:CARRIERID_1

deliveryOptionstringrequired

Delivery Options - Applicable values EMAIL/FAX/MAIL

Allowed values:EMAILFAXMAIL

Example:EMAIL

emailstring

User’s email

Example:abc.def@gmail.com

effectiveFromstring(date-time)required

Date (with pattern “yyyy-MM-dd’T’HH:mm:ss’Z’”) when the preference will be effective, default value is ‘2999-12-31T00:00:00.000Z’

effectiveTostring(date-time)

Date (with pattern “yyyy-MM-dd’T’HH:mm:ss’Z’”) when the preference will stop being effective

documentTypestringrequired

Type of document

Allowed values:NWBANSTCONFTAXAGNTPOLPG

Example:AGNT

partyIdstringrequired

Unique reference id of the party

Example:f22de4bff27e45d9a7c859e61f668c50

acknowledgedByPartyIdstringrequired

Party that initiated the acknowledgment (i.e. an agent, if not the party referred to by partyId)

Example:f22de4bff27e45d9a7c859e61f668c50

Response

application/json

Success

TransactionAcceptedResponse

correlationIdstring

Unique identifier which used by every system to trace the request

Example:3a2a3435-2089-4b81-9959-e0d569ccf4f0

caseIdstring

Zinnia Live Case ID

Example:CA0000369469

caseStatusstring

Zinnia Live Case Status

Example:IN_PROGRESS

pdfIdstring

Identifier for the generated or associated PDF document (e.g. OnBase document number). Returned on systematic program setup and update submit when available.

Example:DOC-10004567

post/policy/v1/transactions/{planCode}/{policyNumber}/edeliveryenrollment

Body

[ { "carrierId": "CARRIERID_1", "deliveryOption": "EMAIL", "effectiveFrom": "effectiveFrom", "documentType": "AGNT", "partyId": "f22de4bff27e45d9a7c859e61f668c50", "acknowledgedByPartyId": "f22de4bff27e45d9a7c859e61f668c50" } ]
 
application/json