idstringrequired
The unique identifier for the illustration request.
Illustration for in force Indexed Universal Life (IUL)
Retrieves the calculated results for the specified illustration request.
get
https://dev.api.zinnia.io/illustration/v3/indexed-universal-life/in-force/{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
Show Child Parameters
response
Illustration Response for Indexed Universal Life product
Show Child Parameters
get/illustration/v3/indexed-universal-life/in-force/{id}
Authentication
Path Parameters
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
Response
200 application/json
Version information retrieved successfully
string
The current API version
get/illustration/v3/version
200 application/json
Health Check
Returns 200
get
https://dev.api.zinnia.io/illustration/v3/health
Response
200
Response
200
Empty 200 to indicate API is healthy
get/illustration/v3/health
200
Calculate age
Calculates age based on date of birth and as-of date using specified calculation method
post
https://dev.api.zinnia.io/illustration/v3/utility/calculateAge
Body
application/json
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
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
Authentication
Body
{
"dateOfBirth": "1990-08-25",
"asOfDate": "2025-08-25",
"calculationMethod": "AGE_LAST"
}
application/json