Skip to content
Hedge Developer Docs

Broker Submission Requirements

GET
/api/v1/broker/submissions/{submission_id}/requirements
curl --request GET \
  --url https://example.com/api/v1/broker/submissions/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/requirements

The live “what does this submission still need” view: per-market readiness (deterministic, no LLM on this read), carrier-API question gaps, the resolved application-form set, and documents already on file.

Accepts a portal session OR a connected app’s broker_submit OAuth token (Bindly / broker agents poll this between answering and finalizing).

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
submission_id
required
Submission Id
string format: uuid

Responses

Section titled “Responses”

200

Section titled “200”

Successful Response

Media typeapplication/json
BrokerSubmissionRequirementsRead

The one ‘what does this submission still need’ composition: per-market readiness (deterministic, no LLM in this read), live carrier-API question gaps, the resolved application-form set, and the documents already on file. Broker-safe labels only.

object
submission_id
required
Submission Id
string format: uuid
insured_name
Any of:
string
lines
Lines
Array<string>
effective_date
Any of:
string format: date
state
Any of:
string
forms
Forms
Array<string>
form_fill_active
Form Fill Active
boolean
markets
Markets
Array<object>
BrokerRequirementsMarket

One matched market’s readiness. needs_from_you are the gap labels only the broker can supply; hedge_obtains are items Hedge fetches itself (loss runs, enrichment), informational, no action needed.

object
market_name
required
Market Name
string
ready
required
Ready
boolean
needs_from_you
Needs From You
Array<string>
hedge_obtains
Hedge Obtains
Array<string>
carrier_api_sessions
Carrier Api Sessions
Array<object>
BrokerRequirementsCarrierSession

One live carrier-API quote session and its current gaps. Answer the missing_questions via the api-quotes answers endpoint (or the save_carrier_answers MCP tool), then close the session to quote.

object
session_id
required
Session Id
string format: uuid
carrier_slug
required
Carrier Slug
string
program
required
Program
string
status
required
Status
string
outcome
Any of:
string
completion_pct
Completion Pct
number
0
missing_questions
Missing Questions
Array<object>
object
key
additional properties
any
has_quote
Has Quote
boolean
documents_on_file
Documents On File
Array<object>
BrokerRequirementsDocument
object
kind
required
Kind
string
kind_label
required
Kind Label
string
display_name
Any of:
string
Example
{
  "form_fill_active": false,
  "carrier_api_sessions": [
    {
      "completion_pct": 0,
      "has_quote": false
    }
  ]
}

422

Section titled “422”

Validation Error

Media typeapplication/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
Examplegenerated
{
  "detail": [
    {
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example"
    }
  ]
}