Search
K
Policy Transactions

Submit active restrict transaction

Submits restriction add/delete requests for a policy. Kong rewrites this path to the BPM service
/bpm/v1/policies/{planCode}/{policyNumber}/Restrict.

post

Path Parameters

planCodestringrequired

Plan code

Example:EVGFIA909

policyNumberstringrequired

Policy number

Example:EVFIA09222243202

Body

application/json

ActiveRestrictTransactionRequest

Request body for active restrict (POST /bpm/v1/policies/{planCode}/{policyNumber}/Restrict).
Extends the common transaction case request fields with restriction operations.

planCodestring
correlationIdstring
partyIdstring
policyNumberstring
businessKeystring
transactionNamestring
deleteRequestboolean
requestTypestring
submitInfoobject

Submission metadata for active restrict requests

Show Child Parameters
receivedDatestring
carrierIdstring
restrictionarray[object]

Single restriction operation in the submit payload

Show Child Parameters
effectiveDatestring
caseIdstring
documentsarray[object]

Document reference in the submit request (common BPM document fields)

Show Child Parameters
policyFeatureDataobject

Response

application/json

Request accepted; transaction 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

pdfIdstring

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

post/policy/v1/transactions/{planCode}/{policyNumber}/Restrict

Body

{}
 
application/json

Get restriction alerts for a policy

Returns the restriction alert aggregate from TDS. When none exists, response body is {}.
Kong rewrites this path to /bpm/v1/policies/{planCode}/{policyNumber}/Restrict.

get

Path Parameters

planCodestringrequired

Plan code

Example:EVGFIA909

policyNumberstringrequired

Policy number

Example:EVFIA09222243202

Response

application/json

Alert aggregate or empty object when no TDS record exists

One Of
policyNumberstring
planCodestring
correlationIdstring
alertsarray[object]

One restriction alert lifecycle record in TDS

Show Child Parameters
get/policy/v1/transactions/{planCode}/{policyNumber}/Restrict
 
application/json

Get restriction alerts for a policy

Returns the restriction alert aggregate from TDS. When none exists, response body is {}.
Kong rewrites this path to /bpm/v1/policies/{planCode}/{policyNumber}/Restrict/alerts.

get

Path Parameters

planCodestringrequired

Plan code

Example:EVGFIA909

policyNumberstringrequired

Policy number

Example:EVFIA09222243202

Response

application/json

Alert aggregate or empty object when no TDS record exists

One Of
policyNumberstring
planCodestring
correlationIdstring
alertsarray[object]

One restriction alert lifecycle record in TDS

Show Child Parameters
get/policy/v1/transactions/{planCode}/{policyNumber}/Restrict/alerts
 
application/json

Eligibility Check For Non-Financial Transaction

post

Path Parameters

planCodestringrequired
policyNumberstringrequired

Policy Number

transactionTypestringrequired

Transaction Type

Allowed values:addressemailaddressphonebankaccountcommunicationpreference

Response

application/json

Non Financial Eligibility Success Response

TransactionResponse

statusstring

Allowed values:successfailure

errorarray[object]
Show Child Parameters
quoteResponseobject
post/bpm/v1/policies/{planCode}/{policyNumber}/{transactionType}/eligibilitycheck
 
application/json

Eligibility Check Bank Transaction

post

Path Parameters

planCodestringrequired
policyNumberstringrequired

Policy Number

Response

application/json

Bank Success Response

TransactionResponse

statusstring

Allowed values:successfailure

errorarray[object]
Show Child Parameters
quoteResponseobject
post/policy/v1/transactions/{planCode}/{policyNumber}/bankaccount/eligibilitycheck
 
application/json