Search
K
Illustration

Hybrid-IUL-Term (HIT) Illustrations

Hybrid-IUL/Term product illustrations

Illustration for new hybrid-iul-term

Triggers an immediate calculation and returns the calculated results.

post
https://dev.api.zinnia.io/illustration/v3/hybrid-iul-term/new-business

Body

application/json

contains all the input data needed for processing the request

Illustration Request for Hybrid-IUL/Term

Illustration Request for Hybrid-IUL/Term product

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

Response

application/json

the request was processed

Illustration Response for Hybrid-IUL/Term

Illustration Response for Hybrid-IUL/Term 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 Hybrid-IUL/Term product across all scenarios. This object represents a single scenario (e.g. Assumed, Guaranteed, etc)

Show Child Parameters
guaranteedobject

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

Show Child Parameters
midpointobject

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

Show Child Parameters
assumedCapobject

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

Show Child Parameters
assumedFixedobject

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

Show Child Parameters
assumedParobject

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

Show Child Parameters
post/illustration/v3/hybrid-iul-term/new-business

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" } ] }
 
application/json

Illustration for new Hybrid-IUL/Term (HIT)

Retrieves the calculated results for the specified illustration request.

get
https://dev.api.zinnia.io/illustration/v3/hybrid-iul-term/new-business/{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 Hybrid-IUL/Term product

Show Child Parameters
response

Illustration Response for Hybrid-IUL/Term product

Show Child Parameters
get/illustration/v3/hybrid-iul-term/new-business/{id}
 
application/json

Utility

Utility operations

Get API version

Returns the current version of the illustration API

get
https://dev.api.zinnia.io/illustration/v3/version

Response

200 application/json

Version information retrieved successfully

string

The current API version

get/illustration/v3/version
 
200 application/json