Skip to content

Create a submission from documents and/or text (the portal's Upload documents)

POST
/broker/intake
curl --request POST \
--url https://api.hedgespecialty.com/api/v1/broker/intake \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: multipart/form-data' \
--form text=example \
--form files=@file \
--form insured_name=example \
--form effective_date=2026-04-15 \
--form lines_of_business=example \
--form primary_state=example \
--form producer_email=example \
--form hold=false \
--form program_ids=example \
--form client_reference=example \
--form quote=false

The API form of the portal’s Upload documents. Send free text (an email body, notes), documents (ACORDs, loss runs, supplements), or both. Hedge reads them as the portal does (the insured, address, NAICS, lines, effective date, locations), prefills a structured file for Hedge Instant Quote markets only and returns the same response as POST /broker/submissions: each market’s state. Your typed fields win over what Hedge read. Emails follow your brokerage’s notification settings; the defaults match the portal. The documents stay on the file and keep feeding its prefill; identical files in one call are stored once.

When what Hedge read fits no instant market (or names no lines or state) it returns 422 no_instant_market (or missing_core) with email_us and read (what it could read), and creates nothing.

Requires text, insured_name or documents. Machine credentials must name producer_email. client_reference and an Idempotency-Key header make a retry return the saved file. Counts toward the daily create and upload limits.

Idempotency-Key
string
Media typemultipart/form-data
object
text

The risk as you would describe it in an email. Required unless insured_name is given.

string
files

Up to 20 PDFs (ACORDs, loss runs, supplements), 15 MB each.

Array<string>
insured_name
string
effective_date
string format: date
lines_of_business

Comma-separated canonical slugs or common aliases (e.g. gl,property).

string
primary_state

Primary risk state, 2-letter US code.

string
>= 2 characters <= 2 characters
producer_email

REQUIRED when authenticating with a machine credential; the active portal user this submission is attributed to.

string
hold

Accepted and changes nothing for a connected app or machine credential.

boolean
program_ids

Comma-separated Hedge Instant Quote program ids (default every one that fits).

string
client_reference

Your reference; unique per brokerage (a repeat returns that file, 200).

string
<= 128 characters
quote

Quote each market as soon as it is ready.

boolean

Created; each instant market’s state.

Media typeapplication/json

Result of POST /broker/intake.

object
submission_id
required
string format: uuid
state
string
status_label
required
string
marketing_status

Null for an instant-flow file (it never starts marketing).

string
nullable
Allowed values: matching awaiting_finalization
next_step
required
string
client_reference
string
nullable
automatic_quoting
boolean
nullable
markets
Array<object>
nullable

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
id

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
Array<object>
nullable

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
id
required
string
label
required
string
value
required
value_label
string
nullable
message
required
string
documents

The originals stored on the submission, in upload order.

Array<object>
object
id
string format: uuid
display_name
string
applicant
required

What Hedge recorded for the insured, your fields, or the extractor’s when you only sent text.

object
insured_name
string
nullable
dba_name
string
nullable
entity_type
string
nullable
business_phone
string
nullable
business_email
string
nullable
website
string
nullable
naics
string
nullable
nature_of_business
string
nullable
contact_first_name
string
nullable
contact_last_name
string
nullable
contact_email
string
nullable
contact_phone
string
nullable
mailing_address
object
line1
string
line2
string
nullable
city
string
state
string
zip
string
warnings

Non-fatal notices (a file that was not stored, a background enqueue that needs attention, a replayed request).

Array<string>
portal_url
required
string format: uri
Example
{
"marketing_status": "matching",
"markets": [
{
"state": "preparing",
"quote": {
"kind": "quote"
}
}
]
}

A file is not a valid PDF/document

Same Idempotency-Key already in flight

A file is over the 15 MB limit

Unsupported document type

{code: no_instant_market, email_us, read} (nothing created); {code: missing_core, fields, read}; no text, insured_name or documents; missing producer_email for a machine credential; invalid date, state or line of business

Daily create limit reached

Text extraction is temporarily unavailable; your text is preserved