Each Hedge Instant Quote market on the file and where it stands

GET

/broker/submissions/{submission_id}/instant-quotes

const url = 'https://api.hedgespecialty.com/api/v1/broker/submissions/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/instant-quotes';
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/submissions/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/instant-quotes \
  --header 'Authorization: Bearer <token>'

The file’s state, the same body POST /broker/submissions returns: each market’s state, status_label, missing[] (exactly what it still needs), reason when closed and quote when quoted, plus suggested[] (values Hedge picked that you confirm). Poll this every 5 to 10 seconds while markets are preparing or quoting. Read scope.

Authorizations

brokerOAuth

Parameters

Path Parameters

submission_id

required

string format: uuid

Responses

200

The file’s state

application/json

object

submission_id

required

string format: uuid

client_reference

string

nullable

portal_url

required

string

automatic_quoting

required

Created with quote: true: each market quotes as soon as it is ready.

boolean

markets

required

Array<object>

One Hedge Instant Quote program on the file and where it stands.

object

program_id

required

string format: uuid

program

required

string

market_id

string format: uuid

nullable

market

required

string

lines

Array<string>

state

required

preparing: Hedge is preparing the application (poll). needs_answers: answer missing[]. ready: request the quote. quoting: requested. quoted: quote is set. declined / not_a_fit: closed, with reason.

string

Allowed values: preparing needs_answers ready quoting quoted declined not_a_fit

status_label

required

Plain words: Preparing · Needs 2 answers · Ready to quote · Quoting · Quoted · $1,234.00 · Declined · reason · Not a fit · reason.

string

missing

required

Array<object>

object

key

The canonical key (what shared_answers takes); null for a file-level gap.

string

nullable

The market’s own question id (what answers[program_id] takes).

string

nullable

label

required

string

message

required

Plain-language note on what to do. A gap in the business’s own name, address, contact or effective date names the call that sets it: PATCH /broker/submissions/{id}/business and its field.

string

reason

string

nullable

quote

object

quote_id

required

string

kind

required

string

Allowed values: quote indication

premium

Dollars.

number

nullable

total

Dollars

number

nullable

suggested

required

Array<object>

A class Hedge picked, or ranked for an unanswered class question, that you must confirm (the same ranking POST /broker/appetite/instant returns). Confirm it with confirm_suggestions, by answering with the same value, or answer another.

object

program_id

required

string format: uuid

key

string

nullable

required

string

label

required

string

value

required

value_label

string

nullable

message

required

string

warnings

required

Array<string>

Example

{
  "markets": [
    {
      "state": "preparing",
      "quote": {
        "kind": "quote"
      }
    }
  ]
}

404

Not your brokerage’s submission