operationstringrequired
validate business rule for provided operation
Allowed values:ADDUPDATEDELETE
Example:ADD
bankIdstring
bank id
Example:1
Add new Bank Account based on request
Validates bank account change requests for policy parties including ADD, UPDATE, and DELETE operations
post
Query Parameters
Path Parameters
planCodestringrequired
policyNumberstringrequired
partyIdstringrequired
Body
application/json
Body
application/json
BankAccountChangeRequest
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})
bankAccountobjectrequired
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
Request accepted successfully and is being processed.
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}/bankaccount/{partyId}/validation
Path Parameters
Query Parameters
Body
{
"effectiveDate": "effectiveDate",
"bankAccount": {
"startDate": "startDate",
"nameOnAccount": "abcdqwe",
"accountStatus": "ACTIVEBANKACCOUNT",
"accountType": "CHECKING",
"accountNumber": "34567777745678",
"routingNumber": "Routing_Number",
"branchName": "branch_66"
}
}
application/json
Bank Account Change Request
Updates bank account information for a specific party on a policy
put
Path Parameters
planCodestringrequired
policyNumberstringrequired
Policy Number
partyIdstringrequired
PartyId for which Bank Account need to be updated it be avaible under SOR Policy Details
bankIdstringrequired
Body
application/json
Body
application/json
BankAccountChangeRequest
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})
bankAccountobjectrequired
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}/bankaccount/{bankId}
Path Parameters
Body
{
"effectiveDate": "effectiveDate",
"bankAccount": {
"startDate": "startDate",
"nameOnAccount": "abcdqwe",
"accountStatus": "ACTIVEBANKACCOUNT",
"accountType": "CHECKING",
"accountNumber": "34567777745678",
"routingNumber": "Routing_Number",
"branchName": "branch_66"
}
}
application/json
Update Communication Preference based on request
Updates communication preferences for a specific party on a policy
post
Path Parameters
planCodestringrequired
policyNumberstringrequired
Policy Number
partyIdstringrequired
PartyId for which communication Preference need to be updated it be avaible under SOR Policy Details
Body
application/json
Body
application/json
CommunicationPreferenceChangeRequest
correlationIdstring(uuid)
The unique ID to track transaction request across all systems
Example:142f6328-0b47-412d-a1db-375e8cb81cb7
effectiveDatestring(date)required
Date (with pattern “yyyy-mm-dd”)
Match pattern:([0-9]{4})-([0-9]{2})-([0-9]{2})
Example:2022-01-01
communicationPreferenceobjectrequired
Show Child Parameters
caseIdstring
Zinnia Live Case ID
Example:CA0000007389
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/{partyId}/communicationpreference
Path Parameters
Body
{
"effectiveDate": "2022-01-01",
"communicationPreference": {
"preferredCommunicationType": "EMAIL"
}
}
application/json
Update Party Name based on request
post
Path Parameters
planCodestringrequired
policyNumberstringrequired
Policy Number
partyIdstringrequired
PartyId for which party name need to be updated it be avaible under SOR Policy Details
Body
application/json
Body
application/json
PartyNameChangeRequest
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})
partyNameobjectrequired
Show Child Parameters
caseIdstring
Zinnia Live Case ID
Example:CA0000007389
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/{partyId}/partyname
Path Parameters
Body
{
"effectiveDate": "effectiveDate",
"partyName": {}
}
application/json
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
post/bpm/v1/policies/{planCode}/{policyNumber}/parties/{partyRole}
Path Parameters
Body
{
"effectiveDate": "effectiveDate",
"party": {}
}
application/json