ActiveRestrictTransactionRequest
objectRequest 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
objectnamestring
emailstring
Example
ActiveRestrictTdsDocumentRef
objectdocumentIdstring
documentNamestring
Example
ActiveRestrictRestrictedTransactionItem
objecttransactionstring
restrictionTypestring
Restriction classification for the transaction row (e.g. hard vs soft), not the policy restriction category
Example
ActiveRestrictActivationBlock
objecteffectiveDatestring
setByobject
Show Child Parameters
documentsarray[object]
Show Child Parameters
supportingDocumentsarray[object]
Alternative property name for activation documents on deserialize
Show Child Parameters
Example