idstringrequired
The unique identifier for the illustration request.
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
Response
application/json
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}
Authentication
Path Parameters
application/json
Whole Life (WL) Illustrations
Whole Life product illustrations
Illustration for new whole life
Triggers an immediate calculation and returns the calculated results.
post
https://dev.api.zinnia.io/illustration/v3/whole-life/new-business
Body
application/json
Body
application/json
contains all the input data needed for processing the request
Illustration Request for Whole Life
Illustration Request for Whole Life 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
parties
Any Ofarrayrequiredunique-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
Fundamental Options schema. Some products may have product-specific Options.
Show Child Parameters
jurisdictionstringrequired
US state code.https://en.wikipedia.org/wiki/ISO_3166-2:US
Allowed values:AKALARASAZCACOCTDCDEFLGAGUHIIAIDILINKSKYLAMAMDMEMIMNMOMPMSMTNCNDNENHNJNMNVNYOHOKORPAPRRISCSDTNTXUMUTVAVIVTWAWIWVWY
planCodestringrequired
Plan code
Example:EG123
dividendobjectrequired
Dividend configuration for whole life policy
Show Child Parameters
distributionsobject
Distributions
Show Child Parameters
Response
application/json
Response
application/json
the request was processed
Illustration Response for Whole Life
Illustration Response for Whole 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 Whole Life product across all scenarios. This object represents a single scenario (e.g. Assumed, Guaranteed, etc)
Show Child Parameters
guaranteedobject
Outputs for Whole Life product across all scenarios. This object represents a single scenario (e.g. Assumed, Guaranteed, etc)
Show Child Parameters
midpointobject
Outputs for Whole Life product across all scenarios. This object represents a single scenario (e.g. Assumed, Guaranteed, etc)
Show Child Parameters
post/illustration/v3/whole-life/new-business
Authentication
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",
"dividend": {
"dividendOption": {
"sequence": [
{
"from": 1,
"through": 10,
"value": "CASH"
}
]
}
}
}
application/json
Illustration for new whole life
Retrieves the calculated results for the specified illustration request.
get
https://dev.api.zinnia.io/illustration/v3/whole-life/new-business/{id}
Path Parameters
idstringrequired
The unique identifier for the illustration request.
Response
application/json
Response
application/json
the request was processed and results may be retrieved.
inputsobject
Illustration Request for Whole Life product
Show Child Parameters
response
Illustration Response for Whole Life product
Show Child Parameters
get/illustration/v3/whole-life/new-business/{id}
Authentication
Path Parameters
application/json
Hybrid-IUL-Term (HIT) Illustrations
Hybrid-IUL/Term product illustrations