Search
K
Product-Service

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

ProductSearchRequestDto

object
distributorCodesarray[string]

Distributor codes to include (logical OR)

Example:EVGL

distributorNamesarray[string]

Distributor names to match (logical OR, case-insensitive)

distributorEffectiveOnstring

Date on which distributor must be effective

Example:2025-01-15

carrierCodesarray[string]

Carrier codes to include (logical OR)

Example:EVGL, SBGC

carrierNamesarray[string]

Carrier names to match (logical OR, case-insensitive)

cusipsarray[string]

CUSIPs to match exactly (logical OR)

planCodesarray[string]

Plan codes to include (logical OR)

Example:TL0101

productNamesarray[string]

Product names to match (logical OR)

marketingNamesarray[string]

Marketing names to match (logical OR)

legalNamesarray[string]

Legal names to match (logical OR)

typesarray[string]

Product types to include (logical OR)

Allowed values:TERMUNIVERSAL_LIFE

Example:TERM

linestring

Product line to filter by

Allowed values:LIFEANNUITY

versionEffectiveOnstring

Returns products whose version is effective on this date

Example:2025-01-15

statesarray[string]

Two-letter state abbreviations to filter by (logical OR)

Example:NY, FL

stateEffectiveOnstring

Date on which state availability must be effective

Example:2025-01-15

stateAvailableToSellboolean

State-level availability filter

availableToSellboolean

Product-level availability filter

Example

PaginatedProductsResponse

object
countnumberrequired

Total number of records matching the search

Example:121

nextstringrequired

URL to the next page, if any

Example:/product/v2/products/search?offset=10&limit=10

previousstringrequired

URL to the previous page, if any

resultsarray[object]required

Array of products matching the search criteria

Show Child Parameters
Example