Search
K
Product-Service

ProductModelDB

object
productIdstring

Zinnia generated unique ID generated to uniquely identify the product in our product master database

Example:UUID

carrierProductIdstring

Carrier generated unique ID, which may be used to communicate across integrations.

Example:CAR-PROD-123

productMarketingNamestring

Carrier generated marketing name for the product

Allowed values:Everglades Term LifeEverglades Return of Premium TermEverglades Index Universal Life

Example:Everglades Term Life

carrierstring

Unique carrier key used in enterprise APIs

Example:EVGL

productLinestring

Product line category

Allowed values:LIFEANNUITY

Example:LIFE

productTypestring

Product type category

Allowed values:INDEX_UNIVERSAL_LIFEUNIVERSAL_LIFETERM

Example:TERM

planCodestring

Plan code for the product (multiple can exist for a single product)

Example:TL0101

termLengtharray[number]

Term length in years

Allowed values:1510152025303540

Example:10, 20, 30

availableToSellboolean

Indicates if the product is available to sell

Example:true

idstring

Database generated unique ID

Example

Distributor

object
distributorCodestringrequired

Unique distributor code

Example:EVGL

distributorNamestringrequired

Distributor name

Example:Everglades Distribution

startDatestringrequired

Start date of distributor authorization

Example:2025-01-01

endDatestringrequired

End date of distributor authorization

Example:2099-01-01

Example

StateAvailability

object
availableToSellboolean

Indicates whether the product is available to sell in this state

Example:true

startDatestring

Start date of state availability (inclusive)

Example:2025-01-01

endDatestring

End date of state availability

Example:2099-01-01

abbreviationstring

Two-letter state abbreviation

>= 2 characters<= 2 characters

Example:NY

namestring

Full state name

Example:New York

Example

ProductV2Model

object
idstringrequired

System-generated unique identifier (UUID)

Example:7b9f2b65-1b4a-4f4c-9d9d-6a7f5b6d9b1a

carrierCodestringrequired

Unique carrier code

Example:EVGL

carrierNamestringrequired

Carrier name

Example:Everglades

cusipstring

CUSIP identifier (9 characters)

Example:1234567AB

productNamestringrequired

Primary product name

Example:Term Life 20

marketingNamestringrequired

Marketing name for the product

Example:Everglades Term 20

legalNamestringrequired

Full legal name of the product

Example:Everglades Term Life Insurance – 20 Year Level Premium

versionstringrequired

Version identifier

Example:1.0

versionStartDatestringrequired

Version start date

Example:2025-01-01

versionEndDatestringrequired

Version end date

Example:2099-01-01

linestringrequired

Product line classification

Allowed values:LIFEANNUITY

Example:LIFE

typestringrequired

Product type

Allowed values:TERMUNIVERSAL_LIFE

Example:TERM

planCodestringrequired

Plan code

Example:TL0101

availableToSellbooleanrequired

Whether the product is available to sell at product level

Example:true

distributorsarray[object]

List of distributors authorized to sell this product

Show Child Parameters
stateAvailabilityarray[object]required

State-level availability records

Show Child Parameters
Example

ErrorResponse

object
messagestringrequired

Human-readable error description

Example:Invalid orderByDirection. Must be "ASC" or "DESC".

timestampstringrequired

ISO 8601 formatted timestamp of the error occurrence

Example:2025-12-09T16:03:00Z

Example