What this submission still needs

GET

/broker/submissions/{submission_id}/requirements

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

• Production
• Staging sandbox

The contract centerpiece, per-market readiness (needs_from_you = items only you can supply), live carrier question gaps, the resolved form set, and documents already on file. Deterministic and fast; poll it between uploads/answers and finalize.

Authorizations

• brokerOAuth

Parameters

Path Parameters

submission_id

required

string format: uuid

Responses

200

Requirements view

Media typeapplication/json

The live “what’s still needed” view.

object

submission_id

string format: uuid

insured_name

string

lines

Array<string>

effective_date

string format: date

state

string

forms

Application forms Hedge prepares for this risk (ACORD baseline + recommended carrier supplements).

Array<string>

marketing_status

Where the asynchronous marketing pipeline is. Matching runs for a few minutes after finalize, so an empty markets list means “still matching” when this is matching; not “no appetite”.

string

Allowed values: not_started matching matched no_markets_matched

marketing_hint

Human-readable next step for the current marketing_status.

string

nullable

form_fill_active

A live form-fill session owns the form set.

boolean

markets

Per-market readiness (deterministic, no model on this read).

Array<object>

object

market_name

string

ready

boolean

needs_from_you

Items only you can supply.

Array<string>

hedge_obtains

Items Hedge fetches itself; informational.

Array<string>

lane_id

The market lane this row belongs to (same id as rail.lanes[].submission_market_id).

string format: uuid

nullable

program

string

nullable

program_category

The Hedge category of a market program, derived from how Hedge submits to it. instant_quote (“Hedge Instant Quote”): carrier API, Hedge fills gaps with favorable assumptions and quotes in minutes; every assumption is listed for the retail agent to confirm before bind. binding (“Hedge Binding”): carrier portal, Hedge quotes on your behalf. specialty (“Hedge Specialty”): email to an underwriter; completed ACORDs, program supplements and loss runs are needed and a human reads them, so Hedge does not assume.

string

Allowed values: instant_quote binding specialty

category_label

string

nullable

carrier_api_sessions

Instant-quote (carrier API) sessions and their open question gaps.

Array<object>

object

session_id

string format: uuid

carrier_slug

string

program

string

status

string

outcome

string

nullable

completion_pct

number

missing_questions

Array<object>

object

has_quote

boolean

documents_on_file

Array<object>

object

kind

string

kind_label

string

display_name

string

assessment

The canonical per-program requirements assessment (null if that section failed to build).

object

submission_id

string format: uuid

generated_at

string format: date-time

submitted_or_ready

Array<string>

gapped

Array<string>

programs

Array<object>

object

submission_market_id

string format: uuid

market_name

string

nullable

program_id

string format: uuid

nullable

program_display_name

string

nullable

channel

string

nullable

Allowed values: email api portal

program_category

The Hedge category of a market program, derived from how Hedge submits to it. instant_quote (“Hedge Instant Quote”): carrier API, Hedge fills gaps with favorable assumptions and quotes in minutes; every assumption is listed for the retail agent to confirm before bind. binding (“Hedge Binding”): carrier portal, Hedge quotes on your behalf. specialty (“Hedge Specialty”): email to an underwriter; completed ACORDs, program supplements and loss runs are needed and a human reads them, so Hedge does not assume.

string

Allowed values: instant_quote binding specialty

enforcement

string

Allowed values: enforce report_only none

submit_ready

boolean

met

Array<object>

object

key

string

nullable

label

string

severity

Hard or preferred

string

resolution

Broker (you supply), auto (Hedge fetches) or internal

string

repr

Structured, free_text, form or file

string

form_key

string

nullable

due_stage

Quote or bind

string

satisfied

boolean

nullable

blocks_submission

boolean

nullable

unmet

Array<object>

object

key

string

nullable

label

string

severity

Hard or preferred

string

resolution

Broker (you supply), auto (Hedge fetches) or internal

string

repr

Structured, free_text, form or file

string

form_key

string

nullable

due_stage

Quote or bind

string

satisfied

boolean

nullable

blocks_submission

boolean

nullable

deferred

Array<object>

object

key

string

nullable

label

string

severity

Hard or preferred

string

resolution

Broker (you supply), auto (Hedge fetches) or internal

string

repr

Structured, free_text, form or file

string

form_key

string

nullable

due_stage

Quote or bind

string

satisfied

boolean

nullable

blocks_submission

boolean

nullable

evaluated_at

string format: date-time

rail

The per-lane market rail, the same block the broker portal shows (null if that section failed to build).

object

generated_at

string format: date-time

lanes

Array<object>

One market lane on this submission, in the shape the broker portal renders.

object

submission_market_id

The lane id used across this API (lane_id elsewhere).

string format: uuid

market_id

string format: uuid

nullable

market_name

string

nullable

program

string

nullable

program_id

string format: uuid

nullable

program_category

The Hedge category of a market program, derived from how Hedge submits to it. instant_quote (“Hedge Instant Quote”): carrier API, Hedge fills gaps with favorable assumptions and quotes in minutes; every assumption is listed for the retail agent to confirm before bind. binding (“Hedge Binding”): carrier portal, Hedge quotes on your behalf. specialty (“Hedge Specialty”): email to an underwriter; completed ACORDs, program supplements and loss runs are needed and a human reads them, so Hedge does not assume.

string

Allowed values: instant_quote binding specialty

lines

Array<string>

status

string

status_label

string

submit_ready

boolean

gapped

Held for something only you can supply (see unmet_labels).

boolean

unmet_labels

Array<string>

quotes

Array<object>

object

quote_id

string format: uuid

premium_display

string

total_cents

integer

lines

Array<string>

is_revision

boolean

nullable

source_offers

Carrier-original quote or indication documents.

Array<object>

object

presentation_id

string format: uuid

kind

string

Allowed values: quote indication

label

string

document_url

string

filename

string

nullable

bound

boolean

chip

string

Allowed values: bound quoted not_available needs_info in_progress

carrier_api_session_ids

Array<string>

nullable

quote_history

Expired or invalidated quotes, for context.

Array<object>

object

history_key

string

market_name

string

program

string

nullable

outcome

string

Allowed values: expired invalid

observed_at

string format: date-time

next_step

string

nullable

quote_history_unavailable

boolean

Example

{
  "marketing_status": "not_started",
  "markets": [
    {
      "program_category": "instant_quote",
      "category_label": "Hedge Instant Quote"
    }
  ],
  "assessment": {
    "programs": [
      {
        "channel": "email",
        "program_category": "instant_quote",
        "enforcement": "enforce"
      }
    ]
  },
  "rail": {
    "lanes": [
      {
        "program_category": "instant_quote",
        "source_offers": [
          {
            "kind": "quote"
          }
        ],
        "chip": "bound"
      }
    ],
    "quote_history": [
      {
        "outcome": "expired"
      }
    ]
  }
}