Search
K
Policy

PartialWithdrawalOneTimeRequest

object
correlationIdstring
effectiveDatestring(date)
reverseInitiatorboolean

Default:false

transactionAmountsobject
Show Child Parameters
fundAllocationobject
Show Child Parameters
taxWithholdingInstructionsarray[object]
Show Child Parameters
fundDistributionsarray[object]
Show Child Parameters
payeeOrBeneficiaryarray[object]
Show Child Parameters
partiesarray[object]
Show Child Parameters
chargesarray[object]
Show Child Parameters
externalIdentifiersobject
Show Child Parameters
Example

PartialWithdrawalQuoteTransactionAmounts

object
requestedAmountnumber(double)

Example:10

appliedAmountnumber(double)

Example:10

taxableAmountnumber(double)

Example:10

amountTypestring

Allowed values:AMOUNTPERCENTAGEMAXFREEWITHDRAWALAMOUNTWITHDRAWALUNTILBASISEARNINGSONLYPRORATAMODIFIEDEARNINGSONLY

disbursementTypestring

Allowed values:GROSSNETNETNET

disbursementPaymentFormstring

Allowed values:DTCCEFTACHCHECKWIRE

totalChargeAmountnumber(double)

Example:10

Example

PartialWithdrawalQuotePayeeOrBeneficiary

object
partyIdstring
paymentFormstring

Allowed values:DTCCCREDITCARDACHCHECKWIREEXCHANGE

allocationPercentagenumber
bankIdstring
disbursementAmountnumber
payeeGrossAmountnumber

Example:20

Example

PartialWithdrawalOneTimeQuoteResponseParties

object
partyRolestring

Allowed values:OWNERPRIMARYBENEFICIARYCONTINGENTBENEFICIARYINSUREDPAYORPAYEEAGENTPRIMARYWRITINGAGENTPRIMARYSERVICINGAGENTADDITIONALSERVICINGAGENTADDITIONALWRITINGGAGENTTHIRDPARTYDESIGNEEJOINTOWNERCOVERAGEINSUREDASSIGNEEANNUITANTEXCHANGECOMPANYJOINTANNUITANTGRANTORTRUSTEEPOWEROFATTORNEYAUTHORIZEDSIGNATORYOTHERINTERESTEDPARTYCONTINGENTOWNERTHIRDPARTYADMINISTRATORCARRIER

partyIdstring

unique identifier linking the party to the policy

Example:Party_PI_1

paymentFormstring

Allowed values:DTCCCREDITCARDACHCHECKWIREEXCHANGE

allocationPercentagenumber(double)

The percentage of the total disbursement allocated to the payee

Example:100

bankIdstring

A unique identifier for the financial institution handling the transaction

Example:Bank_1

addressIdstring

A unique identifier for the address associated with the payee or policyholder

Example:1

forBenefitOfOrForFurtherCreditstring

FBO - For Benefit Of, FFC - For Further Credit. (To notate a second beneficiary or to designate a person or organization when funds are disbursed out)

Example:John Doe

disbursementAmountnumber
payeeGrossAmountnumber

TBD

Example:20

Example

BasePolicy

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

Example