Skip to content
Hedge Developer Docs

Record the agency's structured answers (partner integrations only)

POST
/broker/submissions/{submission_id}/answers
curl --request POST \
  --url https://api.hedgespecialty.com/api/v1/broker/submissions/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/answers \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'Idempotency-Key: example' \
  --data '{ "answers": [ { "key": "example", "value": "example", "source": "api_program", "program_id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0", "question_id": "example" } ] }'

For an API partner acting for your brokerage (a token carrying the partner claim, with broker_submit) on a submission that partner created, before or after finalize. Any other caller, or a submission the partner did not create, gets 404.

Each answer is checked, and only a key a question carries is ever recorded. An api_program answer is checked against the program’s questions (GET /broker/programs/{program_id}/application-schema): by question_id, whose question’s key it must send, or by key alone when one question carries it. Option values are the program’s own JSON values and are compared exactly (300000 is not "300000"). A hedge_questions answer is checked against the Hedge questions (POST /broker/hedge-questions) by key; a select there takes an option value or its label. Values are type-checked. Program answers may address only the programs of a rater file, or of a standard file’s own lanes. An accepted answer is recorded on the submission as the agency’s own answer under its key, which every Hedge model, carrier application and rendered supplemental reads. A program answer also reaches that program’s live carrier session once one exists. Limits: 500 answers per request, 4,000 characters per text answer, 20,000 characters of JSON per value (250,000 for a list value such as a carrier’s location rows).

Idempotency-Key (at most 128 characters) is required. Retrying the same key with the same body returns the first result; the same key with a different body is a 409.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

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

Header Parameters

Section titled “Header Parameters”
Idempotency-Key
required
string
<= 128 characters

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
answers
required
Array<object>
<= 500 items
object
key
required
string
<= 200 characters
value
required

JSON value typed per the question.

source
required
string
Allowed values: api_program hedge_questions
program_id

Required for api_program.

string format: uuid
nullable
question_id
string
nullable <= 300 characters

Responses

Section titled “Responses”

200

Section titled “200”

The accepted count and each refused answer

Media typeapplication/json
object
accepted
required
integer
rejected
required
Array<object>
object
key
required
string
reason_code
required
string
Allowed values: unknown_key invalid_value not_allowed
message
required
string
Example
{
  "rejected": [
    {
      "reason_code": "unknown_key"
    }
  ]
}

403

Section titled “403”

Token lacks the broker_submit scope

404

Section titled “404”

Not a partner token

409

Section titled “409”

idempotency_key_reused (same key, different body) or answers_in_progress (retry the same request)

422

Section titled “422”

idempotency_key_required, idempotency_key_invalid, or a body validation error