Search
K
Policy Transactions

ActiveRestrictTransactionDocument

object

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

documentIdstring
documentDatestring
documentTypestring
documentTypeDescriptionstring
displayNamestring
policyNumberstring
planCodestring
caseIdstring
Example

ActiveRestrictTransactionRequest

object

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
Example

ActiveRestrictPersonRef

object
namestring
emailstring
Example

ActiveRestrictTdsDocumentRef

object
documentIdstring
documentNamestring
Example

ActiveRestrictRestrictedTransactionItem

object
transactionstring
restrictionTypestring

Restriction classification for the transaction row (e.g. hard vs soft), not the policy restriction category

Example