planCodestringrequired
policyNumberstringrequired
Validate Payor Add request
Validate add Payor based on the request
post
Path Parameters
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/validation
Path Parameters
Body
{
"effectiveDate": "effectiveDate",
"party": {}
}
application/json
Eligibility Check Partial Withdrawal One Time
post
Path Parameters
planCodestringrequired
policyNumberstringrequired
Body
application/json
Body
application/json
PartialWithdrawalOneTimeRequest
correlationIdstring
effectiveDatestring(date)required
reverseInitiatorboolean
Default:false
transactionAmountsobjectrequired
Show Child Parameters
fundAllocationobjectrequired
Show Child Parameters
taxWithholdingInstructionsarray[object]
Show Child Parameters
fundDistributionsarray[object]
Show Child Parameters
payeeOrBeneficiaryarray[object]
Show Child Parameters
partiesarray[object]required
Show Child Parameters
chargesarray[object]
Show Child Parameters
caseIdstring
Zinnia Live Case ID
Example:CA0000007389
overrideboolean
BPM will have to override the rules if this variable is marked as true
Response
application/json
Response
application/json
Parital Withdrawal Success Response
TransactionResponse
statusstring
Allowed values:successfailure
errorarray[object]
Show Child Parameters
quoteResponseobject
post/bpm/v1/policies/{planCode}/{policyNumber}/partialwithdrawalonetime/eligibilitycheck
Path Parameters
Body
{
"effectiveDate": "effectiveDate",
"transactionAmounts": {
"requestedAmount": 0,
"amountType": "AMOUNT",
"disbursementType": "GROSS"
},
"fundAllocation": {
"allocationOption": "PRORATA"
},
"parties": [
{
"partyId": "Party_PI_1",
"paymentForm": "DTCC",
"allocationPercentage": 100
}
]
}
application/json
Eligibility Check Partial Withdrawal One Time
post
Path Parameters
planCodestringrequired
policyNumberstringrequired
Body
application/json
Body
application/json
PartialWithdrawalOneTimeRequest
correlationIdstring
effectiveDatestring(date)required
reverseInitiatorboolean
Default:false
transactionAmountsobjectrequired
Show Child Parameters
fundAllocationobjectrequired
Show Child Parameters
taxWithholdingInstructionsarray[object]
Show Child Parameters
fundDistributionsarray[object]
Show Child Parameters
payeeOrBeneficiaryarray[object]
Show Child Parameters
partiesarray[object]required
Show Child Parameters
chargesarray[object]
Show Child Parameters
caseIdstring
Zinnia Live Case ID
Example:CA0000007389
overrideboolean
BPM will have to override the rules if this variable is marked as true
Response
application/json
Response
application/json
Partial Withdrawal Success Response.yaml
TransactionResponse
statusstring
Allowed values:successfailure
errorarray[object]
Show Child Parameters
quoteResponseobject
post/bpm/v1/policies/{planCode}/{policyNumber}/partialwithdrawalonetime/validation
Path Parameters
Body
{
"effectiveDate": "effectiveDate",
"transactionAmounts": {
"requestedAmount": 0,
"amountType": "AMOUNT",
"disbursementType": "GROSS"
},
"fundAllocation": {
"allocationOption": "PRORATA"
},
"parties": [
{
"partyId": "Party_PI_1",
"paymentForm": "DTCC",
"allocationPercentage": 100
}
]
}
application/json
Submit Partial Withdrawal OneTime
post
Path Parameters
planCodestringrequired
policyNumberstringrequired
Body
application/json
Body
application/json
PartialWithdrawalOneTimeRequest
correlationIdstring
effectiveDatestring(date)required
reverseInitiatorboolean
Default:false
transactionAmountsobjectrequired
Show Child Parameters
fundAllocationobjectrequired
Show Child Parameters
taxWithholdingInstructionsarray[object]
Show Child Parameters
fundDistributionsarray[object]
Show Child Parameters
payeeOrBeneficiaryarray[object]
Show Child Parameters
partiesarray[object]required
Show Child Parameters
chargesarray[object]
Show Child Parameters
caseIdstring
Zinnia Live Case ID
Example:CA0000007389
overrideboolean
BPM will have to override the rules if this variable is marked as true
Response
application/json
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
post/bpm/v1/policies/{planCode}/{policyNumber}/partialwithdrawalonetime
Path Parameters
Body
{
"effectiveDate": "effectiveDate",
"transactionAmounts": {
"requestedAmount": 0,
"amountType": "AMOUNT",
"disbursementType": "GROSS"
},
"fundAllocation": {
"allocationOption": "PRORATA"
},
"parties": [
{
"partyId": "Party_PI_1",
"paymentForm": "DTCC",
"allocationPercentage": 100
}
]
}
application/json
FullSurrender Eligibility Check endpoint
post
Path Parameters
planCodestringrequired
policyNumberstringrequired
Body
application/json
Body
application/json
FullSurrenderRequest
correlationIdstring
The unique ID to track transaction request across all systems
Example:657b717b7dcf554abf9ef067
effectiveDatestring(date)
Date (with pattern “yyyy-mm-dd”) when the transaction was originally scheduled or expected to happen, can be a non-business day
reverseInitiatorboolean
Property to isolate source transaction(s) that initiated the reversal
overrideboolean
BPM will have to override the rules if this variable is marked as true
taxWithholdingInstructionsarray[object]
Show Child Parameters
payeeOrBeneficiaryarray[object]
Show Child Parameters
partiesarray[object]
Show Child Parameters
transactionAmountsobject
Show Child Parameters
chargesarray[object]
Show Child Parameters
caseIdstring
Zinnia Live Case ID
Example:CA0000007389
Response
application/json
Response
application/json
Full Surrender Success Response
TransactionResponse
statusstring
Allowed values:successfailure
errorarray[object]
Show Child Parameters
quoteResponseobject
post/bpm/v1/policies/{planCode}/{policyNumber}/fullsurrender/eligibilitycheck
Path Parameters
Body
{}
application/json