HealthController_getHealth
Response
200
Response
CreateProduct
Create Product
Body
application/json
Body
ProductDataModel
Zinnia generated unique ID generated to uniquely identify the product in our product master database
Example:UUID
Carrier generated unique ID, which may be used to communicate across integrations.
Example:CAR-PROD-123
Carrier generated marketing name for the product
Allowed values:Everglades Term LifeEverglades Return of Premium TermEverglades Index Universal Life
Example:Everglades Term Life
Unique carrier key used in enterprise APIs
Example:EVGL
Product line category
Allowed values:LIFEANNUITY
Example:LIFE
Product type category
Allowed values:INDEX_UNIVERSAL_LIFEUNIVERSAL_LIFETERM
Example:TERM
Plan code for the product (multiple can exist for a single product)
Example:TL0101
Term length in years
Allowed values:1510152025303540
Example:[10,20,30]
Indicates if the product is available to sell
Example:true
Response
Response
Bad Request – validation error or duplicate key
Authentication
Body
QueryProduct
Query and retrieve products with optional filtering. Always returns an array of products, even when no products match the criteria (returns empty array) or when only a single product is found.
Query Parameters
carrier name
carrier product id
product id
product type
offset
limit
Response
application/json
Response
Array of products matching the search criteria. Returns empty array if no products found, single-item array if one product found, or multiple products if many match.
Zinnia generated unique ID generated to uniquely identify the product in our product master database
Example:UUID
Carrier generated unique ID, which may be used to communicate across integrations.
Example:CAR-PROD-123
Carrier generated marketing name for the product
Allowed values:Everglades Term LifeEverglades Return of Premium TermEverglades Index Universal Life
Example:Everglades Term Life
Unique carrier key used in enterprise APIs
Example:EVGL
Product line category
Allowed values:LIFEANNUITY
Example:LIFE
Product type category
Allowed values:INDEX_UNIVERSAL_LIFEUNIVERSAL_LIFETERM
Example:TERM
Plan code for the product (multiple can exist for a single product)
Example:TL0101
Term length in years
Allowed values:1510152025303540
Example:[10,20,30]
Indicates if the product is available to sell
Example:true
Database generated unique ID
Authentication
Query Parameters
Get product by ID
Retrieves a single product by its UUID
Path Parameters
Unique product identifier (UUID)
Response
application/json
Response
Product found
ProductV2Model
System-generated unique identifier (UUID)
Example:7b9f2b65-1b4a-4f4c-9d9d-6a7f5b6d9b1a
Unique carrier code
Example:EVGL
Carrier name
Example:Everglades
CUSIP identifier (9 characters)
Example:1234567AB
Primary product name
Example:Term Life 20
Marketing name for the product
Example:Everglades Term 20
Full legal name of the product
Example:Everglades Term Life Insurance – 20 Year Level Premium
Version identifier
Example:1.0
Version start date
Example:2025-01-01
Version end date
Example:2099-01-01
Product line classification
Allowed values:LIFEANNUITY
Example:LIFE
Product type
Allowed values:TERMUNIVERSAL_LIFE
Example:TERM
Plan code
Example:TL0101
Whether the product is available to sell at product level
Example:true
List of distributors authorized to sell this product
Show Child Parameters
State-level availability records
Show Child Parameters
Authentication
Path Parameters
Search for products by criteria
When searching for products, each separate field combines in a logical AND grouping
Query Parameters
Field to order by
Example:productName
Order direction
Allowed values:ASCDESC
Example:DESC
Number of results to return (max 1000)
>= 10
Example:10
Index to start page search at
>= 0
Example:0
Body
application/json
Body
ProductSearchRequestDto
Distributor codes to include (logical OR)
Example:["EVGL"]
Distributor names to match (logical OR, case-insensitive)
Date on which distributor must be effective
Example:2025-01-15
Carrier codes to include (logical OR)
Example:["EVGL","SBGC"]
Carrier names to match (logical OR, case-insensitive)
CUSIPs to match exactly (logical OR)
Plan codes to include (logical OR)
Example:["TL0101"]
Product names to match (logical OR)
Marketing names to match (logical OR)
Legal names to match (logical OR)
Product types to include (logical OR)
Allowed values:TERMUNIVERSAL_LIFE
Example:["TERM"]
Product line to filter by
Allowed values:LIFEANNUITY
Returns products whose version is effective on this date
Example:2025-01-15
Two-letter state abbreviations to filter by (logical OR)
Example:["NY","FL"]
Date on which state availability must be effective
Example:2025-01-15
State-level availability filter
Product-level availability filter
Response
application/json
Response
Paginated search results
PaginatedProductsResponse
Total number of records matching the search
Example:121
URL to the next page, if any
Example:/product/v2/products/search?offset=10&limit=10
URL to the previous page, if any
Example:[ "" ]
Array of products matching the search criteria