Illustration-Generation

Illustration Generation

Get a specific illustration

Get status of a specific asynchronous calculation request

get
https://uat.api.zinnia.io/illustration/v3/illustration-request/{id}

Query Parameters

formatstring

identifier for an output format

Allowed values:RAW_ILLUSTRATION_VALUESFORMATTED_ILLUSTRATION_PDF

Path Parameters

idstringrequired

the illustration request identifier for which status information is desired

Response

application/json

The request has been processed and results may be retrieved.

One Of
formatstring

identifier for an output format

Allowed values:RAW_ILLUSTRATION_VALUESFORMATTED_ILLUSTRATION_PDF

statusstring

Allowed values:PENDINGCOMPLETEERROR

get/illustration/v3/illustration-request/{id}
 
application/json

Get a specific illustration result

Retrieve the results for the specified illustration request in the specified format

get
https://uat.api.zinnia.io/illustration/v3/illustration-request/{id}/results/{format}

Path Parameters

idstringrequired

The unique identifier for the illustration request.

formatstringrequired

identifier for an output format

Allowed values:RAW_ILLUSTRATION_VALUESFORMATTED_ILLUSTRATION_PDF

Response

The content was successfully retrieved.

Core Calculation - Single Illustration

Describes the payload required for calculation of a single transaction

$schemastring
illustrationTypestringrequired

Allowed values:NEW_BUSINESSINFORCE

calculationTypestringrequired

Type of calculation

Allowed values:QUICK_QUOTESINGLE_ILLUSTRATIONAGGREGATE_ILLUSTRATIONCOMPOSITE_ILLUSTRATIONPOLICY_PAGE_PROJECTION

Example:QUICK_QUOTE

policyDetail

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
projection
Show Child Parameters
get/illustration/v3/illustration-request/{id}/results/{format}
 

Illustration for immediate processing

Triggers an immediate calculation and returns the calculated results.

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

Body

application/json

contains all the input data needed for processing the request

Core Calculation - Single Illustration

Describes the payload required for calculation of a single transaction

$schemastring
illustrationTypestringrequired

Allowed values:NEW_BUSINESSINFORCE

calculationTypestringrequired

Type of calculation

Allowed values:QUICK_QUOTESINGLE_ILLUSTRATIONAGGREGATE_ILLUSTRATIONCOMPOSITE_ILLUSTRATIONPOLICY_PAGE_PROJECTION

Example:QUICK_QUOTE

policyDetail

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

Response

application/json

the request was processed

Core Calculation - Single Illustration

Describes the payload required for calculation of a single transaction

$schemastring
illustrationTypestringrequired

Allowed values:NEW_BUSINESSINFORCE

calculationTypestringrequired

Type of calculation

Allowed values:QUICK_QUOTESINGLE_ILLUSTRATIONAGGREGATE_ILLUSTRATIONCOMPOSITE_ILLUSTRATIONPOLICY_PAGE_PROJECTION

Example:QUICK_QUOTE

policyDetail

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
projection
Show Child Parameters
post/illustration/v3/illustration

Body

{ "illustrationType": "NEW_BUSINESS", "calculationType": "QUICK_QUOTE" }
 
application/json

Term Life (TL) Illustrations

Term Life product illustrations

Illustration for new term life

Triggers an immediate calculation and returns the calculated results.

post
https://uat.api.zinnia.io/illustration/v3/term-life/new-business

Body

application/json

contains all the input data needed for processing the request

Illustration Request for Term Life

Illustration Request for Term 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
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

Fundamental Options schema. Some products may have product-specific Options.

Show Child Parameters
jurisdictionstringrequired

Allowed values:AKALARASAZCACOCTDCDEFLGAGUHIIAIDILINKSKYLAMAMDMEMIMNMOMPMSMTNCNDNENHNJNMNVNYOHOKORPAPRRISCSDTNTXUMUTVAVIVTWAWIWVWY

planCodestringrequired

Plan code

Example:EG123

Response

application/json

the request was processed

Illustration Response for Term Life

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

Show Child Parameters
guaranteedobject

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

Show Child Parameters
post/illustration/v3/term-life/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" }
 
application/json