Search
K
Policy

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

isPreferrednumber

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

Allowed values:true

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

PartyPatchRequestParty

object
partyTypestring

Allowed values:INDIVIDUALORGANIZATIONTRUST

partyRoleIdstring

TBD

parentPartyIdstring

The Parent Party ID is a unique identifier used to establish a hierarchical or relational link between multiple related parties within a life insurance or annuity contract. It is particularly useful in complex ownership or beneficiary structures, such as: Trust-owned policies, Multiple contingent beneficiaries linked to a single primary beneficiary, Parties acting in legal or fiduciary roles (e.g., grantors, trustees, custodians)

Example:1

beneficiaryPercentagenumber(double)

Deprecated - kept for backward compatibility; instead use partyPercentage. The benefit percentage of the beneficiary

Example:100

agentPercentagenumber(double)

Deprecated - kept for backward compatibility; instead use partyPercentage. Commission percentage for each agent

Example:100

agentExternalIdstring

The Id which user enters(Id validated in MCS) - Agent External ID and Compnay ID uniquely identifies the right Agent

Example:3160000751

agentTypestring

Allowed values:ACCOUNTMANAGERADDITIONALCOMPENSATIONRECIPIENTADVANCEDUNDERWRITINGCONSULTANTAGENCYORGENERALAGENTAGENCYDIRECTORAGENCYSUPERINTENDENTAGENCYVICEPRESIDENTAGENTORPRODUCERASSISTANTASSISTANTGROUPUNDERWRITERASSISTANTMANAGERASSISTANTVICEPRESIDENTASSISTANTVPCOMPLIANCEASSOCIATEAGENCYMANAGERASSOCIATEFINANCIALPLANNERASSOCIATEOFFICERMANAGERASSOCIATESALEDEVELOPMENTMANAGERINTRAININGASSOCIATESALESDEVELOPMENTMANAGERBANKBANKEMPLOYEEBRANCHMANAGERBROKERBROKERORDEALERBROKERAGEDIRECTORBROKERAGEGENERALAGENTCERTIFIEDFINANCIALPLANNERDISTRIBUTORFINANCIALCONSULTANTFINANCIALPLANNERMANAGINGDIRECTORMANAGINGGENERALAGENTOFFICEMANAGEROTHERPLATFORMREPQUALIFYINGOFFICERREGISTEREDFINANCIALPLANNERREGISTEREDREPRESENTATIVESALESDEVELOPMENTMANAGERSECONDLINEMANAGERSENIORADMINISTRATIVECONSULTANTSENIORADVANCEDUNDERWRITINGCONSULTANTSENIORFINANCIALPLANNERSENIORGROUPACCOUNTEXECUTIVESENIORGROUPSALESREPRESENTATIVESENIORPARTNERSENIORSALESDEVELOPMENTMANAGERSENIORVICEPRESIDENTSERVICINGBROKERSERVICINGONLYAGENTSOLICITORTEAMUNKNOWN

firstNamestring

The first name of the party/trustee

Example:Karen

middleNamestring

The middle name of the party/trustee

Example:Anne

lastNamestring

The last name of the party/trustee

Example:Bates

fullNamestring

The full name of the party/The legal name of the Trust/Organization

Example:Karen Anne Bates

prefixstring

Allowed values:MRMSMISSMRSDR

suffixstring

The suffix of the party name

Allowed values:JRSNSRIIIIIIIVVVIVII

genderstring

Allowed values:MALEFEMALEUNISEX

dateOfBirthstring(date)

The date of birth of the party

Example:2023-01-01

genderIdentitystring

Gender Identity refers to an individual’s self-identified internal sense of gender, which may differ from their sex assigned at birth. This value reflects how the individual personally defines their gender and may be expressed in free-text to allow for inclusivity and accuracy

Example:TBD

attainedAgeinteger(int32)

Age calculated by date of birth and Policy year

Example:55

birthCountrystring

Allowed values:USCARUEGZAGRNLBEFRESHUITROCHATGBDKSENOPLDEPEMXCUARBRCLCOVEMYAUIDPHNZSGTHJPVNCNTRINPKAFLKIRMADZTNLYGMSNMRMLGNBFNETGBJMULRSLGHNGCFTDCMCVSTGQGABSAOBBAXSDRWETSODJKETZUGBIMZZMMGREZWNAMWLSBWAGKMGWCDVGSHAWFOGLKYGIPTLUIEISALMTCYFIBGGGLTLVEEMDAMBYADSMUAHRSIBAMKXKCZSKLIBMGDFKBZGTSVHNNICRPMHTPRVIGSSXBQGPBOGYECGFPYMQSRUYANTCBLMFMSGUAQBNNRPGTOSBVUFJWFCKNUASKINCTVPFMPPWMHFMSSLCDMVCDOHKMOKHLATTKNJMBDTWMMKRKPLBJOSYIQKWSAOMAEILBHQABTNPTJTMAZGEUZAIPACIERKZKGCCMNBVSCIOWSTLTFYTPNSJTKUMEHMVCXNFCGMCVASZPSJEIMRSMEHMCWCSYEYDSUYUZR

citizenCountrystring

Allowed values:USCARUEGZAGRNLBEFRESHUITROCHATGBDKSENOPLDEPEMXCUARBRCLCOVEMYAUIDPHNZSGTHJPVNCNTRINPKAFLKIRMADZTNLYGMSNMRMLGNBFNETGBJMULRSLGHNGCFTDCMCVSTGQGABSAOBBAXSDRWETSODJKETZUGBIMZZMMGREZWNAMWLSBWAGKMGWCDVGSHAWFOGLKYGIPTLUIEISALMTCYFIBGGGLTLVEEMDAMBYADSMUAHRSIBAMKXKCZSKLIBMGDFKBZGTSVHNNICRPMHTPRVIGSSXBQGPBOGYECGFPYMQSRUYANTCBLMFMSGUAQBNNRPGTOSBVUFJWFCKNUASKINCTVPFMPPWMHFMSSLCDMVCDOHKMOKHLATTKNJMBDTWMMKRKPLBJOSYIQKWSAOMAEILBHQABTNPTJTMAZGEUZAIPACIERKZKGCCMNBVSCIOWSTLTFYTPNSJTKUMEHMVCXNFCGMCVASZPSJEIMRSMEHMCWCSYEYDSUYUZR

birthStatestring

Allowed values:AAAEALAPAKAZARASCACOCTDCDEFLGAGUHIIDILINIAKSKYLAMEMDMAMIMNMSMOMPMTNENVNHNJNMNYNCNDOHOKORPAPRRISCSDTNTXUMUTVTVAVIWAWVWIWY

doingBusinessAsstring

The name the organization is commonly known as

Example:TBD

abbreviatedNamestring

The shortened/abbreviated version of the organization`s name that is unique to the organization

Example:TBD

organizationCodestring

Code to Identify organization

Example:TBD

entityTypestring

Allowed values:SOLEPROPRIETORSHIPGENERALPARTNERSHIPLIMITEDPARTNERSHIPCCORPORATIONSCORPORATIONLIMITEDLIABILITYCOMPANYCHARITABLEORGANIZATIONESTATETRUSTCORPORATIONUNKNOWN

trustDatestring(date)

The trust agreement issued date to the party

Example:2023-01-01

amendedTrustDatestring(date)

The Amended Trust Date refers to the most recent date on which the trust agreement was formally amended or restated, particularly when the trust is designated as the owner or beneficiary of a life insurance or annuity policy

Example:2023-01-01

governingStateOfTruststring

Allowed values:AAAEALAPAKAZARASCACOCTDCDEFLGAGUHIIDILINIAKSKYLAMEMDMAMIMNMSMOMPMTNENVNHNJNMNYNCNDOHOKORPAPRRISCSDTNTXUMUTVTVAVIWAWVWIWY

trustTypestring

Allowed values:INDIVIDUALTRUSTCORPORATETRUSTTESTAMENTARYTRUSTINTERVIVOSTRUSTGRANTORTRUST

trustTitlestring

The title of the trustee

Example:TBD

trustAccessCodestring

Access code of the trustee

Example:TBD

preferredCommunicationTypestring

Allowed values:EMAILREGULARMAILPHONEFAXTEXTNOPREFERENCESPECIFIEDPOSTALOTHER

preferredAddressIndicatorstring

Deprecated - kept for backward compatibility; instead use preferredAddressIndicator under Address section

Example:1

preferredAddressIdstring

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

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

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

partyPercentagenumber(double)DEPRECATED

Party Percentage refers to the proportion of ownership, benefits, or responsibility assigned to a party within an insurance or annuity contract. It is used to distribute policy ownership, benefit payouts, commission sharing, or annuity payments among multiple parties

Example:12.1213

formerNameobject
Show Child Parameters
identificationsarray[object]
Show Child Parameters
taxWithholdingsarray[object]
Show Child Parameters
partyStatusstring

Allowed values:APPROVEDNOTAPPROVEDPROCESSED

isPartyBeneficiaryNonNaturalnumber

A boolean field that indicates whether the beneficiary of a Party (when the Party is a Trust) is Non-Natural. This data point is captured for taxation purposes, as Trusts established for individuals are taxed differently from those benefiting entities

Allowed values:true

isIrrevocablenumber

An indicator if the beneficiary is irrevocable. If yes, when doing any changes the beneficiary must also sign forms

Allowed values:true

isRequiredMinimumDistributionDesignatednumber

An indicator if the beneficiary is designated to be included in Joint RMD calculations

Allowed values:true

lastContactDatestring(date)

Last Contact Date refers to the most recent date on which there was a direct or system-recorded interaction with a party (individual or entity) associated with a policy or contract. This party may be a policyholder, insured, beneficiary, payor, agent, or any other role relevant to life and annuity products.

Example:2023-01-01

beneficiaryShareMethodstring

The Beneficiary Share Method refers to the approach used to allocate the death benefit (or other payouts) among multiple beneficiaries listed under a policy or contract. It determines how the proceeds are divided in the event of the insureds death and is typically defined during policy setup or updated via a beneficiary change request.

Allowed values:PERSTIRPESDISTRIBUTION

addressesarray[object]
Show Child Parameters
phonesarray[object]
Show Child Parameters
emailsarray[object]
Show Child Parameters
bankDetailsarray[object]
Show Child Parameters
startDatestring(date)

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

Example:2023-01-01

endDatestring(date)

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

Example:2023-01-01

beneficiaryAllocationarray[object]
Show Child Parameters
partyAllocationarray[object]
Show Child Parameters
Example

PartyPatchRequestPartyUpdate

object
actionstring

Allowed values:ADDUPDATEDELETE

partyRolestring

Allowed values:PayeePrimaryBeneficiaryContingentBeneficiary

customerIdstring

Assigned by Sales Force and used by all platforms(for Everly). Especially for United web.

Example:0017b000010N4bCAAS

relationshipToPartystring

The type of relationship to the party

Allowed values:TRUSTEETRUSTEEOFMINORTRUSTEEOFINCOMPETENTPOWEROFATTORNEYCONTROLLINGPERSONOFENTITYBROTHERCHILDDAUGHTERDOMESTICPARTNEREXECUTORSFATHERFIANCEGRANDCHILDLIFEPARTNERMOTHERSISTERSONSPOUSESTEPFATHERSTEPMOTHERSELFLEGALGUARDIANBUSINESSBUSINESSASSOCIATEPARTNEREMPLOYERFORMERSPOUSEGRANDPARENTPARENTOWNERSIBLINGSTEPCHILDSTEPARENTOTHERAUNTGRANDFATHERGRANDMOTHERHUSBANDWIFEUNCLENIECENEPHEWESTATETRUSTGRANDSONGRANDDAUGHTERNONSPOUSECHILDRENEQUALLYCHILDRENPERSTIRPESPERSTIRPESSURVIVINGSPOUS

partyobject
Show Child Parameters
Example