planCodestringrequired
policyNumberstringrequired
Add Annuitant
Add annuitant based on the request
post
Path Parameters
Body
application/json
Body
application/json
AnnuitantChangeRequest
effectiveDatestring(date)
Date when the transaction was originally scheduled or expected to happen. It can be a non-business day
Example:2023-01-01
signaturesarray[object]
Signature details for the agent change
Show Child Parameters
partyUpdatesarray[object]
Party updates list
Show Child Parameters
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
post/bpm/v1/policies/{planCode}/{policyNumber}/parties/Annuitant
Path Parameters
Body
{}
application/json
Add Joint Annuitant
Add joint annuitant based on the request
post
Path Parameters
planCodestringrequired
policyNumberstringrequired
Body
application/json
Body
application/json
AnnuitantChangeRequest
effectiveDatestring(date)
Date when the transaction was originally scheduled or expected to happen. It can be a non-business day
Example:2023-01-01
signaturesarray[object]
Signature details for the agent change
Show Child Parameters
partyUpdatesarray[object]
Party updates list
Show Child Parameters
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
post/bpm/v1/policies/{planCode}/{policyNumber}/parties/JointAnnuitant
Path Parameters
Body
{}
application/json
Add Payor
Add Payor based on the request
post
Path Parameters
planCodestringrequired
policyNumberstringrequired
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
post/bpm/v1/policies/{planCode}/{policyNumber}/parties/Payor
Path Parameters
Body
{
"effectiveDate": "effectiveDate",
"party": {}
}
application/json
Party Change request
Update(End date) Payee/Payor/Owner/TPD/Beneficiary and Add new Payee/Payor/Assignee/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, Assignee, ThirdPartyDesignee
Allowed values:PayeePayorAssigneeOwnerThirdPartyDesigneePrimaryBeneficiaryContingentBeneficiary
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
put/bpm/v1/policies/{planCode}/{policyNumber}/parties/{partyId}/{partyRole}
Path Parameters
Body
{
"effectiveDate": "effectiveDate",
"party": {}
}
application/json
Party Change request
Update Payor based on the request
put
Path Parameters
planCodestringrequired
policyNumberstringrequired
partyIdstringrequired
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
put/bpm/v1/policies/{planCode}/{policyNumber}/parties/{partyId}/Payor
Path Parameters
Body
{
"effectiveDate": "effectiveDate",
"party": {}
}
application/json