Add Payee/Payor/Owner/ThirdPartyDesignee/PrimaryBeneficiary/ContingentBeneficiary based on the request
Party for which details are being entered. Possible values are - Owner, Payor, Payee, PrimaryBeneficiary, ContingentBeneficiary, ThirdPartyDesignee
Allowed values:PayeePayorOwnerThirdPartyDesigneePrimaryBeneficiaryContingentBeneficiary
Example:Payee
The unique ID to track transaction request across all systems
Example:5df63b47-54fc-4905-a8ff-e1c5f12e667d
Date the Party was added to the Policy
Match pattern:([0-9]{4})-([0-9]{2})-([0-9]{2})
TBD
Example:0017b000010N4bCAAS
Option available for Owner, Payor, TPD and Beneficiary
Allowed values:TRUSTEETRUSTEEOFMINORTRUSTEEOFINCOMPETENTPOWEROFATTORNEYCONTROLLINGPERSONOFENTITYBROTHERCHILDDAUGHTERDOMESTICPARTNEREXECUTORSFATHERFIANCEGRANDCHILDLIFEPARTNERMOTHERSISTERSONSPOUSESTEPFATHERSTEPMOTHERSELFOTHER
Zinnia Live Case ID
Example:CA0000007389
Flag for delete or update request. If flag==true then Delete Request else Update Request
Default:false
Success
Unique identifier which used by every system to trace the request
Example:3a2a3435-2089-4b81-9959-e0d569ccf4f0
Zinnia Live Case ID
Example:CA0000369469
Zinnia Live Case Status
Example:IN_PROGRESS
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
Update(End date) Payee/Payor/Owner/TPD/Beneficiary and Add new Payee/Payor/Owner/ThirdPartyDesignee/PrimaryBeneficiary/ContingentBeneficiary based on the request
Party for which details are being entered. Possible values are - Owner, Payor, Payee, PrimaryBeneficiary, ContingentBeneficiary, ThirdPartyDesignee
Allowed values:PayeePayorOwnerThirdPartyDesigneePrimaryBeneficiaryContingentBeneficiary
Example:Owner
The unique ID to track transaction request across all systems
Example:5df63b47-54fc-4905-a8ff-e1c5f12e667d
Date the Party was added to the Policy
Match pattern:([0-9]{4})-([0-9]{2})-([0-9]{2})
TBD
Example:0017b000010N4bCAAS
Option available for Owner, Payor, TPD and Beneficiary
Allowed values:TRUSTEETRUSTEEOFMINORTRUSTEEOFINCOMPETENTPOWEROFATTORNEYCONTROLLINGPERSONOFENTITYBROTHERCHILDDAUGHTERDOMESTICPARTNEREXECUTORSFATHERFIANCEGRANDCHILDLIFEPARTNERMOTHERSISTERSONSPOUSESTEPFATHERSTEPMOTHERSELFOTHER
Zinnia Live Case ID
Example:CA0000007389
Flag for delete or update request. If flag==true then Delete Request else Update Request
Default:false
Success
Unique identifier which used by every system to trace the request
Example:3a2a3435-2089-4b81-9959-e0d569ccf4f0
Zinnia Live Case ID
Example:CA0000369469
Zinnia Live Case Status
Example:IN_PROGRESS
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
Success
Allowed values:successfailure
Evaluates whether the policy is eligible for a tax withholding change transaction.
Plan Code
Example:EVIU101
Policy Number
Example:EVIUL7RED012
Tax Withholding Eligibility Success Response
Allowed values:successfailure
Validates the tax withholding change request against business rules before submission.
Plan Code
Example:EVIU101
Policy Number
Example:EVIUL7RED012
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.
Plan code (may duplicate path parameter)
Example:EVIU101
Policy number (may duplicate path parameter)
Example:EVIUL7RED012
Effective date for the tax withholding change
Match pattern:([0-9]{4})-([0-9]{2})-([0-9]{2})
Example:2026-06-17
The unique ID to track transaction request across all systems
Example:e3bdb22b-790f-4357-ae60-42cdb0ff0d12
Carrier identifier
Example:FNWL
Zinnia Live Case ID
Example:CA0000007389
Tax withholding instruction lines for the request
>= 1 items
Tax Withholding Validation Success Response
Allowed values:successfailure