Search
K
Policy Transactions

ActiveRestrictActivationBlock

object
effectiveDatestring
setByobject
Show Child Parameters
documentsarray[object]
Show Child Parameters
supportingDocumentsarray[object]

Alternative property name for activation documents on deserialize

Show Child Parameters
Example

ActiveRestrictDeactivationBlock

object
effectiveDatestring
setByobject
Show Child Parameters
supportingDocumentsarray[object]
Show Child Parameters
Example

ActiveRestrictAlertEntry

object

One restriction alert lifecycle record in TDS

idstring
restrictionTypestring
statusstring
activationDetailsobject
Show Child Parameters
deactivationDetailsobject
Show Child Parameters
restrictedTransactionarray[object]
Show Child Parameters
Example

ActiveRestrictPolicyAlertDocument

object

Policy-level restriction alert aggregate (GET /bpm/v1/policies/{planCode}/{policyNumber}/Restrict when data exists).

policyNumberstring
planCodestring
correlationIdstring
alertsarray[object]

One restriction alert lifecycle record in TDS

Show Child Parameters
Example

AddressChangeRequest

object
correlationIdstring

The unique ID to track transaction request across all systems

Example:657b717b7dcf554abf9ef067

preferredAddressIndicatorstringrequired

Indicates whether the address being added should be set as default or not.

Allowed values:TrueFalse

reverseInitiatorboolean

Property to isolate source transaction(s) that initiated the reversal

Default:false

effectiveDatestring(date)required

Date (with pattern “yyyy-mm-dd”)

Match pattern:([0-9]{4})-([0-9]{2})-([0-9]{2})

addressobjectrequired
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

Example