planCodestringrequired
policyNumberstringrequired
Policy Number
Validation multi agent Transaction
post
Path Parameters
Body
application/json
Body
application/json
AgentChangeDto
fromAORstring
From AOR
Example:744760
toAORstring
To AOR
Example:744760
fromAgentIdstring
From agent id
Example:744760
toAgentIdstring
To agent id
Example:744760
policyIdstring
Policy number
Example:FNWL0020303021
caseIdstring
Case id
Example:CA0004789
partyRolestring
Party role
Example:PRIMARYWRITINGAGENT
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
Multi Agent Change Success Response.yaml
TransactionResponse
statusstring
Allowed values:successfailure
errorarray[object]
Show Child Parameters
quoteResponseobject
post/bpm/v1/policies/{planCode}/{policyNumber}/multi-agent/validation
Path Parameters
Body
{}
application/json
Delete TPD party for a policy
delete
Path Parameters
planCodestringrequired
policyNumberstringrequired
Policy Number
partyIdstringrequired
Party ID
Body
application/json
Body
application/json
ThirdPartyDeleteRequest
effectiveDatestring(date)required
Date when the transaction was originally scheduled or expected to happen. It can be a non-business day
Example:2023-01-01
signaturesarray[object]required
Signature details for the agent change
Show Child Parameters
partyobjectrequired
Show Child Parameters
Response
application/json
Response
application/json
Delete TPD Success Response.yaml
TransactionResponse
statusstring
Allowed values:successfailure
errorarray[object]
Show Child Parameters
quoteResponseobject
delete/bpm/v1/policies/{planCode}/{policyNumber}/parties/{partyId}/ThirdPartyDesignee
Path Parameters
Body
{
"effectiveDate": "2023-01-01",
"signatures": [
{}
],
"party": {}
}
application/json
Validation multi agent Transaction
post
Path Parameters
planCodestringrequired
policyNumberstringrequired
Policy Number
Body
application/json
Body
application/json
AgentChangeDto
fromAORstring
From AOR
Example:744760
toAORstring
To AOR
Example:744760
fromAgentIdstring
From agent id
Example:744760
toAgentIdstring
To agent id
Example:744760
policyIdstring
Policy number
Example:FNWL0020303021
caseIdstring
Case id
Example:CA0004789
partyRolestring
Party role
Example:PRIMARYWRITINGAGENT
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
Multi Agent Change Success Response.yaml
TransactionResponse
statusstring
Allowed values:successfailure
errorarray[object]
Show Child Parameters
quoteResponseobject
post/bpm/v1/policies/{planCode}/{policyNumber}/multi-agent/validation
Path Parameters
Body
{}
application/json
Delete TPD party for a policy
delete
Path Parameters
planCodestringrequired
policyNumberstringrequired
Policy Number
partyIdstringrequired
Party ID
Body
application/json
Body
application/json
ThirdPartyDeleteRequest
effectiveDatestring(date)required
Date when the transaction was originally scheduled or expected to happen. It can be a non-business day
Example:2023-01-01
signaturesarray[object]required
Signature details for the agent change
Show Child Parameters
partyobjectrequired
Show Child Parameters
Response
application/json
Response
application/json
Delete TPD Success Response.yaml
TransactionResponse
statusstring
Allowed values:successfailure
errorarray[object]
Show Child Parameters
quoteResponseobject
delete/bpm/v1/policies/{planCode}/{policyNumber}/parties/{partyId}/ThirdPartyDesignee
Path Parameters
Body
{
"effectiveDate": "2023-01-01",
"signatures": [
{}
],
"party": {}
}
application/json
Validation OneTime Premium Transaction
post
Path Parameters
planCodestringrequired
policyNumberstringrequired
Policy Number
Body
application/json
Body
application/json
OneTimePremiumRequest
correlationIdstring
The unique ID to track transaction request across all systems
Example:657b717b7dcf554abf9ef067
effectiveDatestring(date)required
Date when the transaction was originally scheduled or expected to happen. It can be a non-business day
Example:2023-01-01
reverseInitiatorboolean
Property to isolate source transaction(s) that initiated the reversal
transactionAmountsobjectrequired
Show Child Parameters
payor
Any Ofrequired
Variant 1object
Show Child Parameters
caseIdstring
Zinnia Live Case ID
Example:CA0000007389
externalTransactionIdstring
Transaction ID from external system
Example:A12345
overrideboolean
BPM will have to override the rules if this variable is marked as ‘true’
Response
application/json
Response
application/json
OneTime Premium Success Response.yaml
TransactionResponse
statusstring
Allowed values:successfailure
errorarray[object]
Show Child Parameters
quoteResponseobject
post/bpm/v1/policies/{planCode}/{policyNumber}/onetimepremium/validation
Path Parameters
Body
{
"effectiveDate": "2023-01-01",
"transactionAmounts": {
"requestedAmount": 0
},
"payor": {
"bankId": "bankId"
}
}
application/json