Illustration Request
Fundamental Illustration request schema. See the schema for a specific product
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
Source of the request
Example:ZINNIA
Date (with pattern “yyyy-mm-dd”)
Match pattern:([0-9]{4})-([0-9]{2})-([0-9]{2})
Example:2025-05-13
Show Child Parameters
Projection Base
Base for projection scenarios
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
Source of the request
Example:ZINNIA
Date (with pattern “yyyy-mm-dd”)
Match pattern:([0-9]{4})-([0-9]{2})-([0-9]{2})
Example:2025-05-13
Show Child Parameters
A benefit conferred to a group of one or more participants
Show Child Parameters
Any OfMust have at least one party representing the Insured participant
>= 1 items
Represents a party with a roleCode other than INSURED
Show Child Parameters
Fundamental Options schema. Some products may have product-specific Options.
Show Child Parameters
New Business Base
objectProperties for new business scenarios
US state code.https://en.wikipedia.org/wiki/ISO_3166-2:US
Allowed values:AKALARASAZCACOCTDCDEFLGAGUHIIAIDILINKSKYLAMAMDMEMIMNMOMPMSMTNCNDNENHNJNMNVNYOHOKORPAPRRISCSDTNTXUMUTVAVIVTWAWIWVWY
Plan code
Example:EG123
Illustration Request for Term Life
Illustration Request for Term Life product
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
Source of the request
Example:ZINNIA
Date (with pattern “yyyy-mm-dd”)
Match pattern:([0-9]{4})-([0-9]{2})-([0-9]{2})
Example:2025-05-13
Show Child Parameters
A benefit conferred to a group of one or more participants
Show Child Parameters
Any OfMust have at least one party representing the Insured participant
>= 1 items
Represents a party with a roleCode other than INSURED
Show Child Parameters
Fundamental Options schema. Some products may have product-specific Options.
Show Child Parameters
US state code.https://en.wikipedia.org/wiki/ISO_3166-2:US
Allowed values:AKALARASAZCACOCTDCDEFLGAGUHIIAIDILINKSKYLAMAMDMEMIMNMOMPMSMTNCNDNENHNJNMNVNYOHOKORPAPRRISCSDTNTXUMUTVAVIVTWAWIWVWY
Plan code
Example:EG123
Illustration Request for Term Life - Inforce What-If
Illustration Request for Term Life product - Inforce What-If scenario
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
Source of the request
Example:ZINNIA
Date (with pattern “yyyy-mm-dd”)
Match pattern:([0-9]{4})-([0-9]{2})-([0-9]{2})
Example:2025-05-13
Show Child Parameters
A benefit conferred to a group of one or more participants
Show Child Parameters
Any OfMust have at least one party representing the Insured participant
>= 1 items
Represents a party with a roleCode other than INSURED
Show Child Parameters
Fundamental Options schema. Some products may have product-specific Options.
Show Child Parameters
US state code.https://en.wikipedia.org/wiki/ISO_3166-2:US
Allowed values:AKALARASAZCACOCTDCDEFLGAGUHIIAIDILINKSKYLAMAMDMEMIMNMOMPMSMTNCNDNENHNJNMNVNYOHOKORPAPRRISCSDTNTXUMUTVAVIVTWAWIWVWY
Plan code
Example:EG123
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
Date (with pattern “yyyy-mm-dd”)
Match pattern:([0-9]{4})-([0-9]{2})-([0-9]{2})
Example:2025-05-13