Search
K
Policy Transactions

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

AdhocDisbursementParty

object
partyRolestring

Party Role

Allowed values:OWNERPRIMARYBENEFICIARYCONTINGENTBENEFICIARYINSUREDPAYORPAYEEAGENTTHIRDPARTYDESIGNEE

partyIdstringrequired

Pending Review by Product Team

Example:Party_PI_1

paymentFormstringrequired

Mode of payment

Allowed values:DTCCCREDITCARDACHCHECKWIREEXCHANGE

allocationPercentagenumber(double)required

At Policy Level for Each Applicable Fund (Everly there is only one Fixed) Therefore this be 100%

Example:100

bankIdstring

Comes in Acord 103

Example:Bank_1

addressIdstring

Address Id

Example:1

forBenefitOfOrForFurtherCreditstring

FBO - For Benefit Of, FFC - For Further Credit. To notate a second beneficiary or to designate a person or organization when funds are disbursed out.

Example:TBD

Example