PhoneChangeRequest
objectThe unique ID to track transaction request across all systems
Example:657b717b7dcf554abf9ef067
This field is deprecated and will be removed in a future version. Please use phone.isPreferred instead.
Allowed values:YESNO
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
Date (with pattern “yyyy-mm-dd”)
Example:2023-01-01
Show Child Parameters
EmailChangeRequest
objectThe unique ID to track transaction request across all systems
Example:657b717b7dcf554abf9ef067
This field is deprecated and will be removed in a future version. Please use email.isPreferred instead.
Allowed values:YESNO
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
Date (with pattern “yyyy-mm-dd”)
Example:2023-01-01
Show Child Parameters
AddressChangeRequest
objectThe unique ID to track transaction request across all systems
Example:657b717b7dcf554abf9ef067
This field is deprecated and will be removed in a future version. Please use address.isPreferred instead.
Allowed values:YESNO
This field is deprecated and will be removed in a future version. Please use address.isPreferred instead.
Allowed values:YESNO
The Preferred Address ID refers to the unique identifier of the address designated as the primary or preferred address for a given party when multiple addresses are associated with that individual or entity. This ensures consistent use of the correct address for communication, correspondence, and recordkeeping.
Example:1
Date (with pattern “yyyy-mm-dd”)
Example:2023-01-01
Show Child Parameters
Boolean 0 = No 1 = Yes to denote if the email is the preferred
Allowed values:true
The justification or business reason for the transaction
Allowed values:ONETIMEPREMIUMGRACEPERIODPREMIUMREINSTATEMENTPREMIUMEXCHANGE1035SURRENDERAMOUNTEXCESSTOMECAMOUNTEXCESSTOGUIDELINECURRENTVALUECOSTBASISGUIDELINESINGLEPREMIUMGUIDELINELEVELPREMIUMSEVENPAYPREMIUMTOTALYTDPREMIUMAMOUNTFACEDECREASECOVERAGEINITIALPREMIUMEXPIRATIONCOMPLIANCESTARTINGPRICELUMPSUMFIVEYEARDEFERRALSPOUSALCONTINUATIONDISCOUNTCONTROLBUSINESSINDICATORNATIONALCHANGEOFADDRESS
DeliveryDateSetupRequest
objectThe unique ID to track transaction request across all systems
Example:864e43a0-2c2f-4a11-9d7f-69ed40115066
Date when the transaction was originally scheduled or expected to happen. It can be a non-business day
Example:2023-01-01
Property to isolate source transaction(s) that initiated the reversal
PartyName
objectFirst name
Example:John
Middle name
Example:William
Last Name
Example:Doe
Full Name
Example:John William Doe
Allowed values:MRMSMISSMRSDR
The suffix of the party name
Allowed values:JRSNSRIIIIIIIVVVIVII
Doing Business As
Example:TPA
Abbreviated Name
Example:AG