Programs

The carrier programs (products) your brokerage can quote through Hedge

Changed on

The same catalog as GET /broker/market-access, flattened to one row per program with its broker category. instant_quote programs are quoted live through a carrier API and expose an application question schema (below) that your own application builder can plug into; binding programs Hedge quotes for you; specialty programs need completed ACORDs, program requirements and loss runs. Filters combine (AND). Read scope is enough.

get/broker/programs

Request

  • Base URL
    https://api.hedgespecialty.com/api/v1
  • Auth
    OAuth 2
    Authorization code: https://api.hedgespecialty.com/api/v1/oauth/authorize
    Client credentials
    Token URL: https://api.hedgespecialty.com/api/v1/oauth/token

Query parameters

category'instant_quote' | 'binding' | 'specialty'
lobstring

Canonical line slug or common alias (gl

statestring

Response

Programs, instant-quote first, then by market and name

program_idstring uuid required
market_idstring uuid required
market_namestring required
namestring required
program_category'instant_quote' | 'binding' | 'specialty' nullable

instant_quote: quoted live through a carrier API; your own application can plug in via the program's application-schema. binding: Hedge quotes it for you. specialty: completed ACORDs, program requirements and loss runs are required.

category_labelstring nullable
broker_label'instant_quote' | 'binding' | 'specialty' nullable

The broker label from the program's authority. specialty: a carrier underwriter reviews every file (any channel); completed ACORDs, program requirements and loss runs are required. instant_quote: a binding program quoted live through a carrier API. binding: a binding program Hedge quotes through its portal or email. program_category is the route.

linesstring[] required

Canonical line-of-business slugs.

statesstring[] nullable

2-letter state codes where the program is available; null means no state restriction.

descriptionstring nullable
enabledboolean required

Your brokerage's own on/off preference (see GET /broker/market-access).

application_schema_availableboolean required

True when Hedge holds a cached question schema for this program (filed after Hedge's first quote with it), so GET /broker/programs/{program_id}/application-schema will serve it.

Changes