Search
K
Policy

Insured

object
existingLifeInsurancenumber

Any existing life insurance details of the insured

Allowed values:true

existingLifeInsuranceAmountnumber(double)

The existing life insurance amount of the insured

replaceLifeInsurancenumber

Any life insurance replacement details of the insured

Allowed values:true

pendingOrPlanToBuyAdditionalnumber

Any details of pending or plan to buy additional life insurance of the insured

Allowed values:true

isDependentnumber

Any dependent details of the insured

Allowed values:true

employednumber

Any employment details of the insured

Allowed values:true

employmentStatusstring

Allowed values:ACTIVERETIREDDISABLEDLAIDOFFLEAVEDUETOCHILDBIRTHLEAVEDUETOMILITARYSERVICELEAVEOFABSENCERESIGNEDSHORTTERMDISABILITYTERMINATEDUNKNOWNOTHER

occupationstring

Occupation of the insured

Example:Salesman

householdIncomenumber(double)

Household income of the insured

Example:50000

deathDetailsobject
Show Child Parameters
impairmentDetailsobject
Show Child Parameters
Example

Parties

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

partyIdstring

Party 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

Example:Party_PB_Primary_Bene_1

addressesarray[object]

Array of addresses associated with the party

Show Child Parameters
phonesarray[object]

Array of phone numbers associated with the party

Show Child Parameters
emailsarray[object]

Array of emails associated with the party

Show Child Parameters
bankDetailsarray[object]

Array of bank accounts associated with the party

Show Child Parameters
deathDetailsobject
Show Child Parameters
impairmentDetailsobject
Show Child Parameters
timestampstring(date-time)

TBD

Example:2023-01-01T12:00:00.000Z

customerIdstring

Assigned by Sales Force and used by all platforms

Example:0017b000010N4bCAAS

insuredobject

Reference to the Insured model

Show Child Parameters
versionnumber(int32)

Example:1

Example

Policy

object
idstring

Internal ID of the snapshot document

Example:657bddcddc353e5fc5f45acd

eventstring

The transaction type of the current policy snapshot

Example:InterestCreditMatch

effectiveDatestring(date)

Policy as of effective date (with pattern “yyyy-mm-dd”).

Example:2023-01-01

carrierIdstring

The Carrier ID is a unique identifier assigned to an insurance company (carrier) that issues and underwrites a policy. It helps track, manage, and differentiate insurance providers within industry databases, regulatory systems, and digital platforms

Example:SB

policyReferenceIdstring

Attribute name storing the policy reference id generated by RDE system

Example:563f35b74b904f87a2e3ddbde0c3c541

thirdPartyAdministratorIdstring

A Third-Party Administrator (TPA) ID is a unique identifier assigned to a third-party administrator that manages insurance policies, claims, and administrative functions on behalf of an insurance carrier. The TPA ID helps identify the organization handling policy services, claims processing, and compliance reporting

Example:tpa-12345

policySourcestring

Policy Source refers to the origin or method by which a life insurance or annuity application was initiated and submitted, often used to identify how the policy entered the underwriting or issuance workflow. It reflects the channel, system, or direction of application flow, such as inbound or outbound underwriting

Example:Outbound

policySourceDescriptionstring

Policy Source Description provides detailed contextual information about the origin of a policy application, supplementing the high-level Policy Source value. It includes specific identifiers or descriptive data such as the underwriter’s name, referral source, agency, platform, or originating system that processed or submitted the application

Example:Underwriter name

productobject
Show Child Parameters
bandingstring

Banding refers to the grouping of policy coverage amounts into different tiers or “bands” that impact pricing, underwriting, and premium rates. It is commonly used in life insurance pricing models to offer lower per-unit costs for higher coverage amounts

Allowed values:NOPREMIUMBANDING

matchBonusVersionstring

The Match Bonus Version refers to the specific version of match bonus rates applied to a policy or annuity, based on the release date of that rate structure. It ensures that the correct bonus percentage, eligibility criteria, and payout structure are applied according to the policy’s issue date and applicable rate updates

Example:2021.10.15

qualificationTypestring

Qualification type of original policy being exchanged

Allowed values:INDIVIDUALRETIREMENTACCOUNTREGULARINDIVIDUALRETIREMENTACCOUNTSPOUSALINDIVIDUALRETIREMENTACCOUNTROLLOVERROTHINDIVIDUALRETIREMENTACCOUNTCUSTODIALINDIVIDUALRETIREMENTACCOUNTCUSTODIALROTHINDIVIDUALRETIREMENTACCOUNTCUSTODIALROLLOVERINDIVIDUALRETIREMENTACCOUNTQUALIFIEDNONQUALIFIEDSIMPLIFIEDEMPLOYEEPENSIONINDIVIDUALRETIREMENTACCOUNTINHERITEDINDIVIDUALRETIREMENTACCOUNTINHERITEDROTHINDIVIDUALRETIREMENTACCOUNTNONQUALIFIEDSTRETCHINDIVIDUALRETIREMENTACCOUNTSIMPLEQ403BQ401KQ401AQ457BPENSIONPLANCONVERTEDINDIVIDUALRETIREMENTACCOUNTROTH403BCUSTODIALINDIVIDUALRETIREMENTACCOUNTSIMPLIFIEDEMPLOYEEPENSIONKEOGH10CORPORATEPENSIONGROUPTAXSHELTEREDANNUITYPROFITSHARINGTARGETBENEFITCORPORATEDEFERREDCOMPENSATION404EDUCATIONALINDIVIDUALRETIREMENTACCOUNTQN457BCONVERTEDSPOUSALCUSTODIALUNIFORMGIFTSORTRANSFERSTOMINORACT

policyTermnumber(int32)

The Policy Term refers to the number of years a life insurance or annuity contract remains active under its defined premium payment structure. It can represent the fixed duration of a term policy or the maximum period for premium payments in a permanent or flexible premium plan

Example:20

policyYearnumber(int32)

The Policy Year refers to the number of years that have passed since the policy’s effective date. It is used to track policy duration, benefits, premium schedules, surrender charges, and other contractual provisions

Example:1

monthOfYearnumber(int32)

The Policy Months refers to the number of months that have passed since the policy’s effective date. It is used to track policy duration, premium schedules, benefits, and contractual provisions on a monthly basis

Example:2

policyNumberstring

The Policy Number is a unique identifier assigned to a life insurance or annuity contract by the insurance carrier. It serves as the official reference number for tracking, managing, and servicing the policy throughout its lifetime

Example:ZH12345678

parentPolicyNumberstring

The Parent Policy Number is the unique identifier of the original or source insurance policy or contract from which the current policy has been derived, continued, or linked. It serves as a reference point for tracking policy lineage, inheritance, or transformation, and is used to establish relationships between multiple policies

Example:ZNQA12134

priorPolicyNumberstring

The unique identifier of the original policy number of a policy in the case of a conversion, replacement, exchange or reissue

Example:ZNQA12134

policyStatusstring

Allowed values:PENDINGISSUEDNOTISSUEDCANCELEDNOPREMIUMACTIVECANCELEDFREELOOKPENDINGLAPSELAPSETERMINATEDMATUREDSURRENDEREDLIVINGCLAIMPENDINGDEATHCLAIMPENDINGDEATHCLAIMPAIDNOTTAKENISSUEDPARTIALDEATHCLAIMPAYOUT

restrictStatusstring

Allowed values:LEGALOPERATIONAL

issueTypestring

Allowed values:FULLUNDERWRITINGSIMPLIFIEDGUARANTEEISSUEREDUCEDUNDERWRITINGEXPRESSUNDERWRITINGMASSUNDERWRITINGAVIATION

issueStatestring

Allowed values:AAAEALAPAKAZARASCACOCTDCDEFLGAGUHIIDILINIAKSKYLAMEMDMAMIMNMSMOMPMTNENVNHNJNMNYNCNDOHOKORPAPRRISCSDTNTXUMUTVTVAVIWAWVWIWY

currencystring

Allowed values:USDCADAUDNZDGBPEURCHFJPY

policyDatesobject
Show Child Parameters
costBasisobject
Show Child Parameters
fixedCostPeriodnumber(int32)

The Fixed Cost Period refers to the initial guaranteed period (e.g., 10, 20, or 30 years) after the policy start date during which the Protection Costs (Cost of Insurance - COI) remain unchanged or are not charged. Once this period ends, the policy enters the Post Fixed Period, where costs may increase

Example:10

commissionOptionstring

Allowed values:OPTIONAOPTIONBNOCOMMISSIONSTANDARDTRAIL

accountValuesobject
Show Child Parameters
loanValuesobject
Show Child Parameters
withdrawalValuesobject
Show Child Parameters
marketValueAdjustmentobject
Show Child Parameters
requiredMinimumDistributionobject
Show Child Parameters
testValuesobject
Show Child Parameters
timestampstring(date-time)

Example:2023-01-01T12:00:00.000Z

deathBenefitobject
Show Child Parameters
coverageobject
Show Child Parameters
ridersarray[object]
Show Child Parameters
chargesarray[object]
Show Child Parameters
systematicProgramsarray[object]
Show Child Parameters
policyFeaturesarray[object]
Show Child Parameters
allocationobject
Show Child Parameters
versioninteger(int32)

Version number

Example:1

partyRolesarray[object]

Array of party roles

Show Child Parameters
partiesarray[object]

Array of parties

Show Child Parameters
Example

TransactionStatus

string

Allowed values:PendingCompletedFailedReversedCanceledPendingReversal

Outcome

string

Allowed values:truefalse