Policy Transactions
Party Add request
Add Payee/Payor/Owner/ThirdPartyDesignee/PrimaryBeneficiary/ContingentBeneficiary based on the request
post
Path Parameters
planCodestringrequired
policyNumberstringrequired
partyRolestringrequired
Party for which details are being entered. Possible values are - Owner, Payor, Payee, PrimaryBeneficiary, ContingentBeneficiary, ThirdPartyDesignee
Allowed values:PayeePayorOwnerThirdPartyDesigneePrimaryBeneficiaryContingentBeneficiary
Example:Payee
Body
application/json
Body
application/json
PartyChangeRequest
correlationIdstring
The unique ID to track transaction request across all systems
Example:5df63b47-54fc-4905-a8ff-e1c5f12e667d
effectiveDatestring(date)required
Date the Party was added to the Policy
Match pattern:([0-9]{4})-([0-9]{2})-([0-9]{2})
customerIdstring
TBD
Example:0017b000010N4bCAAS
relationshipToInsuredstring
Option available for Owner, Payor, TPD and Beneficiary
Allowed values:TRUSTEETRUSTEEOFMINORTRUSTEEOFINCOMPETENTPOWEROFATTORNEYCONTROLLINGPERSONOFENTITYBROTHERCHILDDAUGHTERDOMESTICPARTNEREXECUTORSFATHERFIANCEGRANDCHILDLIFEPARTNERMOTHERSISTERSONSPOUSESTEPFATHERSTEPMOTHERSELFOTHER
partyobjectrequired
Show Child Parameters
caseIdstring
Zinnia Live Case ID
Example:CA0000007389
deleteRequestboolean
Flag for delete or update request. If flag==true then Delete Request else Update Request
Default:false
Response
application/json
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}/parties/{partyRole}
Authentication
Path Parameters
Body
{
"effectiveDate": "effectiveDate",
"party": {}
}
application/json
Party Change request
Update(End date) Payee/Payor/Owner/TPD/Beneficiary and Add new Payee/Payor/Owner/ThirdPartyDesignee/PrimaryBeneficiary/ContingentBeneficiary based on the request
put
Path Parameters
planCodestringrequired
policyNumberstringrequired
partyIdstringrequired
partyRolestringrequired
Party for which details are being entered. Possible values are - Owner, Payor, Payee, PrimaryBeneficiary, ContingentBeneficiary, ThirdPartyDesignee
Allowed values:PayeePayorOwnerThirdPartyDesigneePrimaryBeneficiaryContingentBeneficiary
Example:Owner
Body
application/json
Body
application/json
PartyChangeRequest
correlationIdstring
The unique ID to track transaction request across all systems
Example:5df63b47-54fc-4905-a8ff-e1c5f12e667d
effectiveDatestring(date)required
Date the Party was added to the Policy
Match pattern:([0-9]{4})-([0-9]{2})-([0-9]{2})
customerIdstring
TBD
Example:0017b000010N4bCAAS
relationshipToInsuredstring
Option available for Owner, Payor, TPD and Beneficiary
Allowed values:TRUSTEETRUSTEEOFMINORTRUSTEEOFINCOMPETENTPOWEROFATTORNEYCONTROLLINGPERSONOFENTITYBROTHERCHILDDAUGHTERDOMESTICPARTNEREXECUTORSFATHERFIANCEGRANDCHILDLIFEPARTNERMOTHERSISTERSONSPOUSESTEPFATHERSTEPMOTHERSELFOTHER
partyobjectrequired
Show Child Parameters
caseIdstring
Zinnia Live Case ID
Example:CA0000007389
deleteRequestboolean
Flag for delete or update request. If flag==true then Delete Request else Update Request
Default:false
Response
application/json
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
put/policy/v1/transactions/{planCode}/{policyNumber}/parties/{partyId}/{partyRole}
Path Parameters
Body
{
"effectiveDate": "effectiveDate",
"party": {}
}
application/json
EligibilityCheck For Party Role Transaction
post
Path Parameters
planCodestringrequired
policyNumberstringrequired
partyRolestringrequired
Response
application/json
Response
application/json
Success
TransactionResponse
statusstring
Allowed values:successfailure
errorarray[object]
Show Child Parameters
quoteResponseobject
post/policy/v1/transactions/{planCode}/{policyNumber}/parties/{partyRole}/eligibilitycheck
Authentication
Path Parameters
application/json
Eligibility Check Tax Withholding
Evaluates whether the policy is eligible for a tax withholding change transaction.
post
Path Parameters
planCodestringrequired
Plan Code
Example:EVIU101
policyNumberstringrequired
Policy Number
Example:EVIUL7RED012
Response
application/json
Response
application/json
Tax Withholding Eligibility Success Response
TransactionResponse
statusstring
Allowed values:successfailure
errorarray[object]
Show Child Parameters
quoteResponseobject
post/policy/v1/transactions/{planCode}/{policyNumber}/parties/taxwithholding/eligibilitycheck
Authentication
Path Parameters
application/json
Validate Tax Withholding
Validates the tax withholding change request against business rules before submission.
post
Path Parameters
planCodestringrequired
Plan Code
Example:EVIU101
policyNumberstringrequired
Policy Number
Example:EVIUL7RED012
Body
application/json
Body
application/json
TaxWithholdingChangeRequest
Request 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
Response
application/json
Response
application/json
Tax Withholding Validation Success Response
TransactionResponse
statusstring
Allowed values:successfailure
errorarray[object]
Show Child Parameters
quoteResponseobject
post/policy/v1/transactions/{planCode}/{policyNumber}/parties/taxwithholding/validation
Authentication
Path Parameters
Body
{
"planCode": "EVIU101",
"policyNumber": "EVIUL7RED012",
"effectiveDate": "2026-06-17",
"correlationId": "e3bdb22b-790f-4357-ae60-42cdb0ff0d12",
"carrierId": "FNWL",
"taxWithholdingInstructions": [
{
"partyId": "2314134",
"taxWithholdingType": "FEDERAL",
"filingStatus": "MARRIED",
"taxRateToUse": "USEVALUESENTERED",
"dollar": 0,
"percentage": 0,
"taxJurisdiction": "USA"
}
]
}
application/json