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
US state code.https://en.wikipedia.org/wiki/ISO_3166-2:US
Allowed values:AKALARASAZCACOCTDCDEFLGAGUHIIAIDILINKSKYLAMAMDMEMIMNMOMPMSMTNCNDNENHNJNMNVNYOHOKORPAPRRISCSDTNTXUMUTVAVIVTWAWIWVWY
Plan code
Example:EG123
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
Show Child Parameters
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
US state code.https://en.wikipedia.org/wiki/ISO_3166-2:US
Allowed values:AKALARASAZCACOCTDCDEFLGAGUHIIAIDILINKSKYLAMAMDMEMIMNMOMPMSMTNCNDNENHNJNMNVNYOHOKORPAPRRISCSDTNTXUMUTVAVIVTWAWIWVWY
Plan code
Example:EG123
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
Show Child Parameters
Illustration Request for IUL
Illustration Request for Indexed Universal 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
US state code.https://en.wikipedia.org/wiki/ISO_3166-2:US
Allowed values:AKALARASAZCACOCTDCDEFLGAGUHIIAIDILINKSKYLAMAMDMEMIMNMOMPMSMTNCNDNENHNJNMNVNYOHOKORPAPRRISCSDTNTXUMUTVAVIVTWAWIWVWY
Plan code
Example:EG123
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
Options for the illustration request.
Show Child Parameters
Show Child Parameters
Specifies what type of conversion is occurring
Show Child Parameters
Additional one-time payments that take place at specified points in time
Show Child Parameters
Fund allocations
Show Child Parameters
Distributions
Show Child Parameters
Show Child Parameters
Illustration Response
Fundamental Illustration response schema. See the schema for a specific product
The unique identifier for the illustration request.
Example:ed13083d-d6b3-463d-a569-56b532d00fcd
A structured signal
Show Child Parameters
Illustration Response for Term Life
Illustration Response for Term Life product
The unique identifier for the illustration request.
Example:ed13083d-d6b3-463d-a569-56b532d00fcd
A structured signal
Show Child Parameters
Outputs for Term Life product across all scenarios. This object represents a single scenario (e.g. Assumed, Guaranteed, etc)
Show Child Parameters
Outputs for Term Life product across all scenarios. This object represents a single scenario (e.g. Assumed, Guaranteed, etc)