Search
K
Illustration

Illustration Response for Term Life

Illustration Response for Term Life product

idstring

The unique identifier for the illustration request.

Example:ed13083d-d6b3-463d-a569-56b532d00fcd

messagesarray[object]

A structured signal

Show Child Parameters
assumedobject

Outputs for Term Life product across all scenarios. This object represents a single scenario (e.g. Assumed, Guaranteed, etc)

Show Child Parameters
guaranteedobject

Outputs for Term Life product across all scenarios. This object represents a single scenario (e.g. Assumed, Guaranteed, etc)

Show Child Parameters
Example

Illustration Response IUL

Illustration Response for Indexed Universal Life product

idstring

The unique identifier for the illustration request.

Example:ed13083d-d6b3-463d-a569-56b532d00fcd

messagesarray[object]

A structured signal

Show Child Parameters
assumedobject

Outputs for Indexed Universal Life product across all scenarios. This object represents a single scenario (e.g. Assumed, Guaranteed, etc)

Show Child Parameters
guaranteedobject

Outputs for Indexed Universal Life product across all scenarios. This object represents a single scenario (e.g. Assumed, Guaranteed, etc)

Show Child Parameters
midpointobject

Outputs for Indexed Universal Life product across all scenarios. This object represents a single scenario (e.g. Assumed, Guaranteed, etc)

Show Child Parameters
alternateobject

Outputs for Indexed Universal Life product across all scenarios. This object represents a single scenario (e.g. Assumed, Guaranteed, etc)

Show Child Parameters
Example

Exchange

object

1035 Exchange - exchanging another policy for this one

amountnumber(double)required

The value of the exchanged policy

Example:5000

basisnumber(double)required

How much can be exchanged without incurring additional taxes

Example:5000

isModifiedEndowmentContractbooleanrequired

Whether the policy being exchanged for this one is a MEC

Example:true

carryoverLoannumber(double)

How much loan is being carried in as part of this exchange

Example:5000

Example

Options

object

Fundamental Options schema. Some products may have product-specific Options.

revisedIllustrationbooleanrequired

Whether the illustration is revised

Example:true

solveForstringrequired

Solve for

Allowed values:PREMIUMFACENO_SOLVE

Example:PREMIUM

fixedCostPeriodnumber

Fixed cost period

Allowed values:1015202530

Example:10

paymentModestringrequired

Frequency

Allowed values:DAILYEVERYTWOWEEKSMONTHLYSEMIANNUALQUARTERLYANNUALSINGLEPAYMENT

Example:DAILY

discountIndicatorstring

Discount indicator

Allowed values:MULTIPRODUCTNON

Example:MULTIPRODUCT

paymentMethodstring

Payment method

Allowed values:DTCCCREDITCARDACHCHECKEXCHANGEWIRE

Example:DTCC

premiumDurationnumber(integer)

Premium duration

Example:10

premiumDurationOptionstring

Premium duration option

Allowed values:AGEYEARS

Example:YEARS

faceAmountobject

Represents a value that changes with time. The value is assumed to change annually and be tied to a duration unless otherwise specified via the Frequency and Basis properties

Show Child Parameters
premiumobject

Represents a value that changes with time. The value is assumed to change annually and be tied to a duration unless otherwise specified via the Frequency and Basis properties

Show Child Parameters
targetCashValueOptionstring

Target cash value option

Allowed values:SPECIFY_AMOUNTENDOWMENT

Example:SPECIFY_AMOUNT

targetCashValueAtOptionstring

Whether to use targetCashValueAge or targetCashValueYear

Allowed values:AGEYEAR

Example:AGE

targetCashValueAgenumber(integer)

If target cash value should be at an age, use this. If it should be at a year, use targetCashValueYear. targetCashValueAtOption determines which is used.

Example:10

targetCashValueYearnumber(integer)

If target cash value should be at a year, use this. If it should be at an age, use targetCashValueAge. targetCashValueAtOption determines which is used.

Example:10

targetCashValueAmountnumber(double)

Target cash value amount

Example:10000

Example

Options for IUL

object

Options for the illustration request.

dolistringrequired

DOLI

Allowed values:GPTCVAT

Example:GPT

deathBenefitOptionobject

Represents a value that changes with time. The value is assumed to change annually and be tied to a duration unless otherwise specified via the Frequency and Basis properties

Show Child Parameters
dumpInAmountnumber(double)

Dump in amount

Example:5432.62

juvenileReclassificationboolean

Indicates that a rating class change will occur for a juvenile upon reaching adulthood

Example:true

preventModifiedEndowmentContractboolean

Whether the selected solve should attempt to prevent this policy from being a MEC

Example:true

illustrationBasisstring

Which scenario’s premium to use as the basis for the other scenarios

Allowed values:CURRENTASSUMEDGUARANTEED

Example:CURRENT

Example