Zinnia Indexed Universal Life (IUL) Illustrations API is one of 42 APIs that Zinnia publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Indexed Universal Life (IUL) Illustrations. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and an API reference.
This API exposes
6 operations
across 6 paths,
and defines 62 schemas.
It is described by OpenAPI 3.2.0, at version 3.5.3.
Requests are made against a single base URL, https://dev.api.zinnia.io.
The identity and technical contract details declared by the specification.
Single-Year-Values-IUL
object
A single-year slice of data that varies annually - these values are specific to IUL products
32 properties
Party-Base
object
Fundamental party object - see schema for specific role
13 properties
2 required
Participant-Collection-V4
array
A collection of unique participants
Illustration-Inputs-Inforce-Base
object
Common properties for inforce illustration scenarios
2 properties
2 required
Financial-Activity
object
1 property
1 required
Illustration-Response-IUL
object
Illustration Response for Indexed Universal Life product
4 properties
PropertyCollection-Withdrawal
object
Reusable collection of withdrawal-related properties
3 properties
Arrangement
object
Describes an arbitrary agreement
10 properties
Arrangements
array
An unkeyed collection of arrangement objects
Message
object
A structured signal
4 properties
2 required
Coverage-Collection
array
A collection of benefits
Non-Insured-Party
object
Represents a party with a roleCode other than INSURED
1 property
1 required
Policy-State
object
Represents the state of a policy at an instant in time. Describes the payload Zahara transmits when requesting calculations for a single transaction.
13 properties
13 required
Illustration-Response-Base
object
Fundamental Illustration response schema. See the schema for a specific product
2 properties
Schedule-Premium
object
1 property
Illustration-Inputs-IUL-Inforce-What-If
Illustration Request for Indexed Universal Life product - Inforce what-if scenario
Scenario-Base
object
Fundamental outputs that apply across all products. This object represents a single scenario (e.g. Assumed, Guaranteed, etc)
20 properties
Party-Role
string
The role of a given party
Flat-Extra
object
5 properties
Schedule
object
Represents a value that changes with time. The value is assumed to change annually and be tied to a duration unless otherwise specified via the Frequency and B…
3 properties
1 required
Fund-Collection
array
An unkeyed collection of funds
Conversion
object
Specifies what type of conversion is occurring
3 properties
2 required
Scenario-IUL
object
Outputs for Indexed Universal Life product across all scenarios. This object represents a single scenario (e.g. Assumed, Guaranteed, etc)
Options-IUL
object
Options for the illustration request.
Schedule-DBO
object
1 property
Basic-Collection
object
A simple object that only contains a collection of unique attributes and no further structure.
1 property
1 required
Participant-Collection
array
An unkeyed collection of unique participant objects
Illustration-Inputs-IUL
Illustration Request for Indexed Universal Life product
PropertyCollection-Loan
object
Reusable collection of loan-related properties
6 properties
Arrangement-Type
string
Enumeration of allowable arrangement types
Schedule-Base
object
Represents a value that changes with time. The value is assumed to change annually and be tied to a duration unless otherwise specified via the Frequency and B…
3 properties
1 required
Frequency
string
Frequency
Variable-Value
the value of a variable, may be constant or time-dependent
Arrangement-Source
object
A source of funding for an arrangement
2 properties
2 required
Fund
object
A source of money
2 properties
2 required
Account-Value
object
A description of the monetary value of an investment contract
4 properties
4 required
Schedule-FaceAmount
object
1 property
Attribute-Collection
object
A collection of uniquely named variables, must be camel-cased.
1 property
IUL-Shared-Properties
object
Properties shared between IUL and HIT products
5 properties
1 required
Distribution-Sequence-FromThrough
object
From/Through
2 properties
Illustration-Inputs-Projection-Base
Base for projection scenarios
Single-Year-Values-Base
object
A single-year slice of data that varies annually - these values apply to any scenario and any product
14 properties
Coverage
object
A benefit conferred to a group of one or more participants
3 properties
3 required
Active-Segment
object
A segment of a source of money that has some form of financial activity
2 properties
1 required
Scheduled-Entry
object
Represents a limited time period for which a value is constant.
3 properties
3 required
Illustration-Inputs-IUL-Inforce-As-Is
Illustration Request for Indexed Universal Life product - Inforce as-is scenario
Participant
object
An entity with a stake in a policy
2 properties
2 required
Multiple-Basic-Collections
array
Parties
array
An unkeyed collection of unique Party objects
Party
object
A unique entity
4 properties
4 required
Date-Field
string
Date (with pattern "yyyy-mm-dd")
Illustration-Inputs-Base
object
Fundamental Illustration request schema. See the schema for a specific product
4 properties
2 required
Insured
object
Represents a party with roleCode: Insured
1 property
3 required
Options-Base
object
Fundamental Options schema. Some products may have product-specific Options.
17 properties
3 required
IUL-Shared-Scenario-Properties
object
Scenario properties shared between IUL and HIT products
35 properties
Coverage-Collection-V4
array
A collection of benefits
IUL-Shared-Options
object
Options shared between IUL and HIT products
6 properties
1 required
Exchange
object
1035 Exchange - exchanging another policy for this one
4 properties
3 required
Features
object
Well-known geatures associated with a policy
4 properties
4 required
Illustration-Inputs-New-Business-Base
object
Properties for new business scenarios
2 properties
2 required
Output-Coverage-Values
object
Result values relevant to a specific coverage
10 properties
Distributions
object
Distributions
3 properties
2 required
The full machine-readable OpenAPI contract behind this narrative.
Other APIs Zinnia publishes across the network.
