Search
K
Illustration

Illustration Request for IUL - Inforce As-Is

Illustration Request for Indexed Universal Life product - Inforce as-is scenario

calculationTypestringrequired

Type of calculation. Only SINGLE_ILLUSTRATION triggers a PDF to be generated.

Allowed values:QUICK_QUOTESINGLE_ILLUSTRATIONAGGREGATE_ILLUSTRATIONCOMPOSITE_ILLUSTRATIONPOLICY_PAGE_PROJECTIONINITIAL_QUOTE

Example:QUICK_QUOTE

sourcestring

Source of the request

Example:ZINNIA

illustrationRequestDatestring(date)required

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

Match pattern:([0-9]{4})-([0-9]{2})-([0-9]{2})

Example:2025-05-13

reportsobject
Show Child Parameters
policyDetailrequired

Represents the state of a policy at an instant in time. Describes the payload Zahara transmits when requesting calculations for a single transaction.

Show Child Parameters
policyDetailDatestring(date)required

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

Match pattern:([0-9]{4})-([0-9]{2})-([0-9]{2})

Example:2025-05-13

Example

Illustration Response

Fundamental Illustration response schema. See the schema for a specific product

idstring

The unique identifier for the illustration request.

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

messagesarray[object]

A structured signal

Show Child Parameters
Example

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