Skip to content
Hedge Developer Docs

Answer the file's gaps (shared and per market)

PATCH
/broker/submissions/{submission_id}/answers
curl --request PATCH \
  --url https://api.hedgespecialty.com/api/v1/broker/submissions/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/answers \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "shared_answers": {}, "answers": { "additionalProperty": {} }, "confirm_suggestions": false, "producer_email": "example" }'

shared_answers by canonical key are written to the file and refill every market that asks them (a later answer corrects an earlier one, as in the portal; a key no market on the file asks is ignored and named in warnings[]); answers[program_id] go to that market’s application (a question’s id, or its canonical key; a row’s question as rows[record_id].field). A market still preparing takes its answers once prepared. confirm_suggestions: true confirms each class Hedge suggested (suggested[]) as it stands; to pick another class, answer it.

All or nothing: any refused answer returns 422 invalid_answers with errors[] (program_id, key, message) and nothing is saved. Submit scope; producer_email with a machine credential.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

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

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
shared_answers
object
key
additional properties
any
answers
object
key
additional properties
object
key
additional properties
any
confirm_suggestions
boolean
producer_email
string

Responses

Section titled “Responses”

200

Section titled “200”

The file’s state after the answers

Media typeapplication/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
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
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
id
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"
      }
    }
  ]
}

409

Section titled “409”

not_instant_flow: the file was not created through this flow

422

Section titled “422”

invalid_answers with errors[]