Search
K
Policy

LinkBankingItem

object
SourceSystemstringrequired

Allowed values:LC

BankIdstringrequired
BankNamestringrequired
ABANumberstringrequired
AccountNumberstringrequired
BankStartDatestring(date-time)required
BankEndDatestring(date-time)required
BankingTypeDescstringrequired
Example

LinkBanking

object
Itemsarray[object]required
Show Child Parameters
Example

Quote

object
ClientCodestringrequired
ContractNumberstringrequired
PlanCodestringrequired
UserIdstringrequired
TransactionDatestringrequired
TransactionTimestringrequired
Withdrawalarray[object]required
Show Child Parameters
Example

PhoneChangeRequest

object
correlationIdstring

The unique ID to track transaction request across all systems

Example:657b717b7dcf554abf9ef067

isPreferredPhonestring

This field is deprecated and will be removed in a future version. Please use phone.isPreferred instead.

Allowed values:YESNO

preferredPhoneIdstring

The Preferred Phone ID refers to the unique identifier of the phone number designated as the primary contact number for a given individual or entity when multiple phone numbers are associated with the same party

Example:1

effectiveDatestring(date)

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

Example:2023-01-01

phoneobject
Show Child Parameters
Example

EmailChangeRequest

object
correlationIdstring

The unique ID to track transaction request across all systems

Example:657b717b7dcf554abf9ef067

isPreferredEmailstringDEPRECATED

This field is deprecated and will be removed in a future version. Please use email.isPreferred instead.

Allowed values:YESNO

preferredEmailIdstring

The Preferred Email ID refers to the unique identifier of the email address designated as the primary or preferred email contact for an individual or entity when multiple email addresses are on file.

Example:1

effectiveDatestring(date)

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

Example:2023-01-01

emailobject
Show Child Parameters
Example