Search
K
Illustration

Illustration for in-force indexed universal life - what-if scenario

Triggers an immediate calculation and returns the calculated results.

post
https://dev.api.zinnia.io/illustration/v3/indexed-universal-life/in-force/what-if

Body

application/json

contains all the input data needed for processing the request

Illustration Request for IUL - Inforce What-If

Illustration Request for Indexed Universal Life product - Inforce what-if 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
coveragesarray[object]required

A benefit conferred to a group of one or more participants

Show Child Parameters
partiesAny Of
arrayrequiredunique-items

Must have at least one party representing the Insured participant

>= 1 items

Non-Insured Partyobject

Represents a party with a roleCode other than INSURED

Show Child Parameters
optionsobject

Options for the illustration request.

Show Child Parameters
jurisdictionstringrequired

Allowed values:AKALARASAZCACOCTDCDEFLGAGUHIIAIDILINKSKYLAMAMDMEMIMNMOMPMSMTNCNDNENHNJNMNVNYOHOKORPAPRRISCSDTNTXUMUTVAVIVTWAWIWVWY

planCodestringrequired

Plan code

Example:EG123

conversionobject

Specifies what type of conversion is occurring

Show Child Parameters
lumpSumDepositsarray[object]

Additional one-time payments that take place at specified points in time

Show Child Parameters
fundAllocationsarray[object]required

Fund allocations

Show Child Parameters
distributionsobject

Distributions

Show Child Parameters
exchangesobject
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

Response

application/json

the request was processed

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
post/illustration/v3/indexed-universal-life/in-force/what-if

Body

{ "calculationType": "QUICK_QUOTE", "illustrationRequestDate": "2025-05-13", "coverages": [ { "coverageId": "BASE_COVERAGE" } ], "parties": [ { "partyId": "95f5ece9-e40b-450b-ad39-daa217894e69", "partyTypeCode": "INDIVIDUAL", "roleCode": "OWNER" } ], "jurisdiction": "AK", "planCode": "EG123", "fundAllocations": [ { "allocationPercent": 50, "fundId": "SPX" } ], "policyDetail": "", "policyDetailDate": "2025-05-13" }
 
application/json

Illustration for in-force Indexed Universal Life (IUL) what-if scenario

Retrieves the calculated results for the specified illustration request.

get
https://dev.api.zinnia.io/illustration/v3/indexed-universal-life/in-force/what-if/{id}

Path Parameters

idstringrequired

The unique identifier for the illustration request.

Response

application/json

the request was processed and results may be retrieved.

inputsobject

Illustration Request for Indexed Universal Life product - Inforce what-if scenario

Show Child Parameters
response

Illustration Response for Indexed Universal Life product

Show Child Parameters
get/illustration/v3/indexed-universal-life/in-force/what-if/{id}
 
application/json

Illustration for in-force indexed universal life - as-is scenario

Triggers an immediate calculation and returns the calculated results.

post
https://dev.api.zinnia.io/illustration/v3/indexed-universal-life/in-force/as-is

Body

application/json

contains all the input data needed for processing the request

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

Response

application/json

the request was processed

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
post/illustration/v3/indexed-universal-life/in-force/as-is

Body

{ "calculationType": "QUICK_QUOTE", "illustrationRequestDate": "2025-05-13", "policyDetail": "", "policyDetailDate": "2025-05-13" }
 
application/json

Illustration for in-force Indexed Universal Life (IUL) as-is scenario

Retrieves the calculated results for the specified illustration request.

get
https://dev.api.zinnia.io/illustration/v3/indexed-universal-life/in-force/as-is/{id}

Path Parameters

idstringrequired

The unique identifier for the illustration request.

Response

application/json

the request was processed and results may be retrieved.

inputsobject

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

Show Child Parameters
response

Illustration Response for Indexed Universal Life product

Show Child Parameters
get/illustration/v3/indexed-universal-life/in-force/as-is/{id}
 
application/json

Utility

Utility operations