Search
K
Policy Transactions

PartyChange

object
correlationIdstring

The unique ID to track transaction request across all systems

Example:5df63b47-54fc-4905-a8ff-e1c5f12e667d

effectiveDatestring(date)required

Date the Party was added to the Policy

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

customerIdstring

TBD

Example:0017b000010N4bCAAS

relationshipToInsuredstring

Option available for Owner, Payor, TPD and Beneficiary

Allowed values:TRUSTEETRUSTEEOFMINORTRUSTEEOFINCOMPETENTPOWEROFATTORNEYCONTROLLINGPERSONOFENTITYBROTHERCHILDDAUGHTERDOMESTICPARTNEREXECUTORSFATHERFIANCEGRANDCHILDLIFEPARTNERMOTHERSISTERSONSPOUSESTEPFATHERSTEPMOTHERSELFOTHER

partyobjectrequired
Show Child Parameters
Example

Party

object
startDatestring(date)

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

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

endDatestring(date)

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

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

partyIdstring

Party ID at Policy Level that comes in from External source (for Everly it will be Acord 103)

Example:Party_PB_Primary_Bene_1

partyTypestring

Defines Party type example individual or Organization. For Insured this should always be Individual

Allowed values:IndividualOrganization

firstNamestring

The first name of the party

Example:Karen

middleNamestring

The middle name of the party

Example:Anne

lastNamestring

The last name of the party

Example:Bates

fullNamestring

Fullname of the party. Available only when PartyType is Trust/Organization

Example:Karen Anne Bates

prefixstring

The prefix of the party party name

Allowed values:MRMSMISSMRS

suffixstring

The suffix of the party party name

Allowed values:JRSNIIIIII

genderstring

Party gender

Allowed values:MALEFEMALEUNISEX

dateOfBirthstring(date)

Party date of birth (with pattern “yyyy-mm-dd”)

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

attainedAgenumber(int32)

Party age calculated by Date of Birth

Example:55

birthCountrystring

Abbreviated names for countries

Allowed values:USCARUEGZAGRNLBEFRESHUITROCHATGBDKSENOPLDEPEMXCUARBRCLCOVEMYAUIDPHNZSGTHJPVNCNTRINPKAFLKIRMADZTNLYGMSNMRMLGNBFNETGBJMULRSLGHNGCFTDCMCVSTGQGABSAOBBAXSDRWETSODJKETZUGBIMZZMMGREZWNAMWLSBWAGKMGWCDVGSHAWFOGLKYGIPTLUIEISALMTCYFIBGGGLTLVEEMDAMBYADSMUAHRSIBAMKXKCZSKLIBMGDFKBZGTSVHNNICRPMHTPRVIGSSXBQGPBOGYECGFPYMQSRUYANTCBLMFMSGUAQBNNRPGTOSBVUFJWFCKNUASKINCTVPFMPPWMHFMSSLCDMVCDOHKMOKHLATTKNJMBDTWMMKRKPLBJOSYIQKWSAYEOMAEILBHQABTNPTJTMAZGEUZAIPACIERKZKGCCMNBVSCIOWSTLTFYTPNSJTKUMEHMVCXNFCWCGMCVASZPSJEIMRSMEHM

birthStatestring

Abbreviated names for states

Allowed values:ALAKAZARCACOCTDCDEFLGAHIIDILINIAKSKYLAMEMDMAMIMNMSMOMTNENVNHNJNMNYNCNDOHOKORPARISCSDTNTXUTVTVAWAWVWIWY

Example:AL

doingBusinessAsstring

The name the organization is commonly known as

Example:TBD

abbreviatedNamestring

TBD

Example:TBD

organizationCodestring

Code to Identify organization

Example:TBD

entityTypestring

Type of Organization Structure (Partnership, corporation etc)

Allowed values:SOLEPROPRIETORSHIPGENERALPARTNERSHIPLIMITEDPARTNERSHIPCCORPORATIONSCORPORATIONLIMITEDLIABILITYCOMPANYCHARITABLEORGANIZATIONESTATETRUSTCORPORATION

trustDatestring(date)

The trust agreement issued date to the party

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

trustTitlestring

The title of the trustee

Example:TBD

trustAccessCodestring

Access code of the trustee

Example:TBD

preferredCommunicationTypestring

The preference of communication such as phone, email or mail

Allowed values:EMAILMAILPHONEFAXTEXTNONEOTHER

textstring

If type OTHER, then provide further info using text.

Example:in-person or video call id https://company.us/j/1234567890

preferredAddressIndicatorstring

Indicates whether the address being added should be set as default or not. Yes - address being entered is default.

Allowed values:YESNO

formerNameobject
Show Child Parameters
identificationsarray[object]
Show Child Parameters
addressesarray[object]
Show Child Parameters
phonesarray[object]
Show Child Parameters
emailsarray[object]
Show Child Parameters
bankDetailsarray[object]
Show Child Parameters
beneficiaryAllocationsarray[object]
Show Child Parameters
taxWithholdingsarray[object]
Show Child Parameters
Example

Country

string

Abbreviated names for countries

Allowed values:USCARUEGZAGRNLBEFRESHUITROCHATGBDKSENOPLDEPEMXCUARBRCLCOVEMYAUIDPHNZSGTHJPVNCNTRINPKAFLKIRMADZTNLYGMSNMRMLGNBFNETGBJMULRSLGHNGCFTDCMCVSTGQGABSAOBBAXSDRWETSODJKETZUGBIMZZMMGREZWNAMWLSBWAGKMGWCDVGSHAWFOGLKYGIPTLUIEISALMTCYFIBGGGLTLVEEMDAMBYADSMUAHRSIBAMKXKCZSKLIBMGDFKBZGTSVHNNICRPMHTPRVIGSSXBQGPBOGYECGFPYMQSRUYANTCBLMFMSGUAQBNNRPGTOSBVUFJWFCKNUASKINCTVPFMPPWMHFMSSLCDMVCDOHKMOKHLATTKNJMBDTWMMKRKPLBJOSYIQKWSAYEOMAEILBHQABTNPTJTMAZGEUZAIPACIERKZKGCCMNBVSCIOWSTLTFYTPNSJTKUMEHMVCXNFCWCGMCVASZPSJEIMRSMEHM

State

string

Abbreviated names for states

Allowed values:ALAKAZARCACOCTDCDEFLGAHIIDILINIAKSKYLAMEMDMAMIMNMSMOMTNENVNHNJNMNYNCNDOHOKORPARISCSDTNTXUTVTVAWAWVWIWY

Example

FormerName

firstNamestring

First name

Example:John

middleNamestring

Middle name

Example:William

lastNamestring

Last Name

Example:Doe

fullNamestring

Full Name

Example:John William Doe

prefixstring

Prefix Type

Allowed values:MRMSMISSMRS

suffixstring

Suffix Type

Allowed values:JRSNIIIIII

doingBusinessAsstring

Doing Business As

Example:TPA

abbreviatedNamestring

Abbreviated Name

Example:AG

Example