The application question schema for an instant-quote program

GET

/broker/programs/{program_id}/application-schema

const url = 'https://api.hedgespecialty.com/api/v1/broker/programs/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/application-schema';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://api.hedgespecialty.com/api/v1/broker/programs/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/application-schema \
  --header 'Authorization: Bearer <token>'

Exactly the questions Hedge’s carrier integration asks for this program, the schema the carrier application is filed on, projected for your own application builder: sections of questions with stable keys, labels, types, options, help, and depends_on visibility dependencies. Collect answers against these keys, then save them to the submission’s application via the application-workspace checkpoint. Optional lob/state check that the program lists that line / state. Programs Hedge quotes itself have no schema: 404 with code: no_application_schema pointing at GET /broker/markets/{market_id}/requirements.

Authorizations

brokerOAuth

Parameters

Path Parameters

program_id

required

string format: uuid

Query Parameters

lob

string

state

string

>= 2 characters <= 2 characters

Responses

200

The projected question schema

application/json

object

program_id

required

string format: uuid

market_id

required

string format: uuid

name

required

string

program_category

required

string

Allowed value: instant_quote

contract_version

required

string

Allowed value: structured_v1

schema_fingerprint

required

Content hash of the served schema; changes when the carrier’s questions change. Per-application fingerprints for checkpoints come from the application-workspace.

string

title

string

nullable

description

string

nullable

sections

required

Array<object>

object

key

required

string

label

required

string

questions

required

Array<object>

object

key

required

Stable answer key; use it as the answer key in application checkpoints.

string

label

required

string

type

required

Normalized field type (e.g. text, number, boolean, select, multiselect, date, group, collection).

string

required

required

boolean

options

Array<object>

nullable

object

value

label

string

help

string

nullable

depends_on

Keys of other questions whose answers decide whether this one applies.

Array<string>

nullable

required_when

Conditional requiredness when declared: {field, op (equals|not_equals|in|not_in|truthy|falsy), value}.

object

one_of_group

string

nullable

repeatable

required

True for collections (answer is a list of items shaped by questions).

boolean

questions

Array<object> recursive

Example

{
  "program_category": "instant_quote",
  "contract_version": "structured_v1"
}

404

Program not visible to your brokerage, not available for the given line/state, or not an instant-quote program (code: no_application_schema)

503

The carrier’s schema could not be loaded right now (code: application_schema_unavailable); retry