Search
K
Policy

AddressBase

object
startDatestring

The start date of the party address. Date (with pattern “yyyy-mm-dd”)

Example:2023-01-01

endDatestring

The end date of the party address. Date (with pattern “yyyy-mm-dd”)

Example:2023-01-01

addressTypestring

Allowed values:RESIDENCEBUSINESSPOBOXSEASONALSECONDARYMAILING

addressLine1string

Address Line 1 of the party address

Example:1112 Pickle Street

addressLine2string

Address Line 2 of the party address

Example:South Jersey

addressLine3string

Address Line 3 of the party address

Example:1234 Post box

citystring

City of the party address

Example:Garden City

statestring

Allowed values:AAAEALAPAKAZARASCACOCTDCDEFLGAGUHIIDILINIAKSKYLAMEMDMAMIMNMSMOMPMTNENVNHNJNMNYNCNDOHOKORPAPRRISCSDTNTXUMUTVTVAVIWAWVWIWY

zipCodestring

Zip code of the party address

Example:67846

zipCodeExtensionstring

Unit of the party address

Example:23

countrystring

Allowed values:USCARUEGZAGRNLBEFRESHUITROCHATGBDKSENOPLDEPEMXCUARBRCLCOVEMYAUIDPHNZSGTHJPVNCNTRINPKAFLKIRMADZTNLYGMSNMRMLGNBFNETGBJMULRSLGHNGCFTDCMCVSTGQGABSAOBBAXSDRWETSODJKETZUGBIMZZMMGREZWNAMWLSBWAGKMGWCDVGSHAWFOGLKYGIPTLUIEISALMTCYFIBGGGLTLVEEMDAMBYADSMUAHRSIBAMKXKCZSKLIBMGDFKBZGTSVHNNICRPMHTPRVIGSSXBQGPBOGYECGFPYMQSRUYANTCBLMFMSGUAQBNNRPGTOSBVUFJWFCKNUASKINCTVPFMPPWMHFMSSLCDMVCDOHKMOKHLATTKNJMBDTWMMKRKPLBJOSYIQKWSAOMAEILBHQABTNPTJTMAZGEUZAIPACIERKZKGCCMNBVSCIOWSTLTFYTPNSJTKUMEHMVCXNFCGMCVASZPSJEIMRSMEHMCWCSYEYDSUYUZR

isPreferredboolean

TBD

Example

PhoneBase

object
startDatestring(date)

The start date of when the party can be reached via the phone.Date (with pattern “yyyy-mm-dd”)

Example:2023-01-01

endDatestring(date)

The end date of when the party can be reached via the phone. Date (with pattern “yyyy-mm-dd”)

Example:2023-01-01

phoneTypestring

Allowed values:MOBILEHOMEBUSINESSCLAIMCENTERCUSTOMERSERVICECORPORATEOFFICEFAXUNKNOWNOTHER

countryCodestring

Country Code of the phone

Example:9

areaCodestring

Area code of the phone

Example:973

dialNumberstring

Dial number of the phone

Example:765789

extensionstring

Dial in Extension for phone

Example:null

bestTimestring

The best time to contact the party via phone

Example:null

timezonestring

Timezone for the entered phone details

Example:null

isPreferredboolean

The Preferred Phone Indicator is a boolean flag or attribute assigned to each phone number associated with a party, used to identify which phone number should be used as the primary contact number for communication

Example

EmailBase

object
startDatestring(date)

The start date of when the party can be reached via email.Date (with pattern “yyyy-mm-dd”)

Example:2023-01-01

endDatestring(date)

The end date of when the party can be reached via email. Date (with pattern “yyyy-mm-dd”)

Example:2023-01-01

emailTypestring

Allowed values:PERSONALBUSINESSCUSTOMERSERVICEOTHER

emailAddressstring

Email address of the party

Example:will.smith@gmail.com

isPreferredboolean

The Preferred Email Indicator is a boolean flag associated with each email address linked to a party, used to designate which email address should be treated as the primary contact for electronic communications

Example

BankAccountBase

object
startDatestring(date)

Date the Bank Account of the Party was added to the Policy. Date (with pattern “yyyy-mm-dd”)

Example:2023-01-01

endDatestring(date)

Date the Bank Account of the Party was terminated from the Policy. Date (with pattern “yyyy-mm-dd”)

Example:2023-01-01

nameOnAccountstring

Name of the Party on Bank Account

Example:abcdqwe

accountStatusstring

Allowed values:ACTIVEBANKACCOUNTTERMINATEDBANKACCOUNT

accountTypestring

Allowed values:CHECKINGSAVINGSCREDITCARDDEBITCARDBROKERAGEACCOUNTCERTIFICATEOFDEPOSITWIRE

bankAccountPurposestring

Allowed values:LOANINTERESTBILLINGDISBURSEMENTSLOANPRINCIPALBILLINGPREMIUMBILLINGONETIMEPREMIUMBILLINGPAYOUTONETIMEWIRE

accountNumberstring

The 7+ digit checking or savings account number

Example:34567777745678

routingNumberstring

The 9-digit routing transit number for the bank account/branch

Example:123456789

internationalBankAccountNumberstring

The bank account number for an international bank account (this field does not have check-digit validation)

Example:ibanNumber_66

branchNamestring

The name of the bank (such as Chase Manhattan)

Example:branch_66

branchPhoneNumberstring

Phone Number of the Bank Branch

Example:7766667777

branchAddressobject
Show Child Parameters
Example

PartyAllocation

object
partyPolicyIdstring

Party Policy ID is a unique identifier assigned to a party (individual or entity) involved in an insurance or annuity contract. This identifier helps ensure accurate data exchange and tracking across insurance transactions

allocationPercentagenumber(double)
Example