Product API
API Base URL
- Server 1:https://uat.api.zinnia.io
Security
ProductDataModel
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:EVGL-PROD-001
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:EVGUL001
termLengtharray[number]
Term length in years
Allowed values:1510152025303540
Example:[10,20,30]
availableToSellboolean
Indicates if the product is available to sell
Example:true