Search
K
Illustration

Illustration for immediate processing

Triggers an immediate calculation and returns the calculated results.

post
https://dev.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://dev.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

jurisdictionstringrequired

Allowed values:AKALARASAZCACOCTDCDEFLGAGUHIIAIDILINKSKYLAMAMDMEMIMNMOMPMSMTNCNDNENHNJNMNVNYOHOKORPAPRRISCSDTNTXUMUTVAVIVTWAWIWVWY

planCodestringrequired

Plan code

Example:EG123

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

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", "jurisdiction": "AK", "planCode": "EG123", "coverages": [ { "coverageId": "BASE_COVERAGE" } ], "parties": [ { "partyId": "95f5ece9-e40b-450b-ad39-daa217894e69", "partyTypeCode": "INDIVIDUAL", "roleCode": "OWNER" } ] }
 
application/json

Illustration for new term life

Triggers an immediate calculation and returns the calculated results.

get
https://dev.api.zinnia.io/illustration/v3/term-life/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.

inputs

Illustration Request for Term Life product

Show Child Parameters
response

Illustration Response for Term Life product

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

Illustration for in force term life

Triggers an immediate calculation and returns the calculated results.

post
https://dev.api.zinnia.io/illustration/v3/term-life/in-force

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

jurisdictionstringrequired

Allowed values:AKALARASAZCACOCTDCDEFLGAGUHIIAIDILINKSKYLAMAMDMEMIMNMOMPMSMTNCNDNENHNJNMNVNYOHOKORPAPRRISCSDTNTXUMUTVAVIVTWAWIWVWY

planCodestringrequired

Plan code

Example:EG123

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

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/in-force

Body

{ "calculationType": "QUICK_QUOTE", "illustrationRequestDate": "2025-05-13", "jurisdiction": "AK", "planCode": "EG123", "coverages": [ { "coverageId": "BASE_COVERAGE" } ], "parties": [ { "partyId": "95f5ece9-e40b-450b-ad39-daa217894e69", "partyTypeCode": "INDIVIDUAL", "roleCode": "OWNER" } ] }
 
application/json