Illustration-Generation

Illustration Generation

Illustration for new Hybrid-IUL/Term (HIT)

Retrieves the calculated results for the specified illustration request.

get
https://uat.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://uat.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

Calculate age

Calculates age based on date of birth and as-of date using specified calculation method

post
https://uat.api.zinnia.io/illustration/v3/utility/calculateAge

Body

application/json

Age calculation request containing date of birth, as-of date, and calculation method

Age-Calculation-Request

dateOfBirthstring(date)required

Date of birth in ISO-8601 format

Example:1990-08-25

asOfDatestring(date)required

As-of date in ISO-8601 format

Example:2025-08-25

calculationMethodstringrequired

Age calculation method - AGE_LAST for age at last birthday, AGE_NEAREST for age at nearest birthday

Allowed values:AGE_LASTAGE_NEAREST

Example:AGE_LAST

Response

application/json

Age calculation completed successfully

Age-Calculation-Response

ageinteger

Calculated age

Example:35

monthsSinceLastBirthdayinteger

Number of months since last birthday

Example:0

post/illustration/v3/utility/calculateAge

Body

{ "dateOfBirth": "1990-08-25", "asOfDate": "2025-08-25", "calculationMethod": "AGE_LAST" }
 
application/json

Modified-Endowment-Contract

object
adjustmentIndicatornumber(integer)

Adjustment indicator

conversionYearnumber(integer)

Conversion year

Example