Search
K
Policy

RequiredMinimumDistributionOneTimeRequest

object
correlationIdstring
effectiveDatestring(date)
reverseInitiatorboolean

Default:false

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

QuoteTransactionAmount

object
requestedAmountnumber(double)

The amount requested for the transaction.

Example:10

appliedAmountnumber(double)

The portion of the requested amount that was successfully applied to the policy.

Example:10

netPaymentAmountnumber(double)

The net amount paid out after all deductions, taxes, and charges have been applied.

Example:10

taxableAmountnumber(double)

The portion of the transaction amount that is considered taxable based on IRS regulations.

Example:10

amountTypestring

Allowed values:AMOUNTPERCENTAGEMAXFREEWITHDRAWALAMOUNTWITHDRAWALUNTILBASISEARNINGSONLYPRORATAPERCENTMODIFIEDEARNINGSONLYSUNINCOMEMAXIMIZERONLYLBRMAXIMUMSUNINCOMEMAXIMIZERNETONETIMEACCESSNONSUNINCOMEMAXIMIZERLBRSWDMAXIMUMSUNINCOMEMAXIMIZERGROSSONETIMEACCESSYEARTODATEFIXEDEARNINGSEARNINGSLIQUIDITYFIRSTEARNINGSLIQUIDITYLASTGUARANTEEDWITHDRAWALBENEFITFIXEDMODIFIEDEARNINGSACCUMULATEDEARNINGSLIFEEXPECTANCYDEFAULT

disbursementTypestring

Allowed values:GROSSNETNETNET

disbursementPaymentFormstring

Allowed values:DTCCEFTACHCHECKWIRE

premiumPortionAmountnumber(double)

The amount paid toward the premium when the policy has a loan balance.

Example:10

loanRepaymentPortionAmountnumber(double)

The amount paid toward the Loan Repayment when the policy has a loan balance.

Example:10

Example

QuotePayeeOrBeneficiary

object
partyIdstringrequired
paymentFormstring

Allowed values:DTCCCREDITCARDACHCHECKWIREEXCHANGEPREMIUMLOAN

allocationPercentnumberrequired
financialInstitutionPartyIdstringrequired
disbursementAmountnumber(double)

The actual dollar amount disbursed to the payee.

Example:100

Example

RequiredMinimumDistributionOneTimeQuoteResponse

object
correlationIdstring

The unique ID to track the transaction request across all systems.

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

transactionAmountsobject
Show Child Parameters
taxWithholdingInstructionsarray[object]
Show Child Parameters
taxWithheldAmountsarray[object]
Show Child Parameters
partiesarray[object]
Show Child Parameters
chargesarray[object]
Show Child Parameters
policyobject
Show Child Parameters
Example

MultipleEmailChangeRequest

object
correlationIdstring

The unique ID to track transaction request across all systems

Example:657b717b7dcf554abf9ef067

effectiveDatestring(date)

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

Example:2023-01-01

emailsarray[object]
Show Child Parameters
Example