The consolidated application workspace for a submission

GET

/broker/submissions/{submission_id}/application-workspace

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

• Production
• Staging sandbox

One read for everything an external application builder needs on a submission: the shared facts (facts) and one ApplicationSection per active carrier application, its question schema (the same questions as the program’s application-schema), current answers, per-field ownership, missing required keys, readiness, the last quote request state and result, and the revision tokens every write must echo. Submissions not on the structured workflow return workflow_version: legacy with no applications. Read scope is enough.

Authorizations

• brokerOAuth

Parameters

Path Parameters

submission_id

required

string format: uuid

Responses

200

Workspace

Media typeapplication/json

The consolidated per-submission application surface: the shared facts plus one ApplicationSection per active carrier application. Submissions not on the structured application workflow return workflow_version: legacy with an empty applications list.

object

contract_version

string

Allowed value: structured_v1

workspace_id

required

string

workflow_version

required

structured_v1, or legacy when this submission does not use the workspace.

string

facts

The submission’s shared facts (the Brief) as the applications see them; one revision counter for the whole set.

object

contract_version

required

string

Allowed value: structured_v1

workspace_id

required

string

fact_set_id

required

string

owner_host

required

string

Allowed values: hedge bindly

owner_resource_id

required

string

revision

required

integer

replica_applied_revision

integer

facts

required

Array<object>

object

key

required

string

value

required

scope

string

default: insured

period

string

nullable

source

required

Provenance of a fact or answer.

object

source_id

required

string

content_hash

required

string

channel

required

string

Allowed values: broker_portal broker_email insured connected_app document paste mapping

evidence

string

default: explicit

Allowed values: explicit translated assumed

snippet

string

nullable

extractor_version

string

nullable

confirmed

boolean

applications

required

Array<object>

One carrier application (a carrier-API quote session) inside the workspace: its schema, current answers, per-field ownership, and readiness. application_id is the session_id used by the checkpoint / request-quote / employers-classes paths. Revisions (answer_revision, fact_revision, selection_revision) and schema_fingerprint are the optimistic-concurrency tokens every command must echo.

object

application_id

required

string

workspace_id

required

string

connection_id

string

provider_key

required

string

program_identifier

required

string

owner_host

string

Allowed values: hedge bindly

owner_session_id

string

route

string

Allowed values: hedge direct

market_program_id

string format: uuid

nullable

submission_id

string format: uuid

nullable

line_of_business

string

nullable

schema

required

The normalized question schema (fields, required_field_keys, program identity); the same questions GET /broker/programs/{program_id}/application-schema projects.

object

schema_fingerprint

required

string

answers

required

Current answers keyed by question key.

object

key

additional properties

any

ownership

object

key

additional properties

object

kind

string

Allowed values: explicit derived cleared

revision

integer

source

Provenance of a fact or answer.

object

source_id

required

string

content_hash

required

string

channel

required

string

Allowed values: broker_portal broker_email insured connected_app document paste mapping

evidence

string

default: explicit

Allowed values: explicit translated assumed

snippet

string

nullable

extractor_version

string

nullable

dependencies

Array<string>

answer_revision

required

integer

fact_revision

integer

selection_revision

integer

selected_products

Array<string>

available_products

Array<string>

mapping_state

Whether Hedge’s fact-to-answer mapping is idle or still running for this application.

string

unresolved_dependencies

Array<string>

missing

Required question keys still unanswered.

Array<string>

errors

Array<object>

object

key

additional properties

string

visible_fields

Array<string>

readiness

required

needs_information until every required visible question is answered, then ready_for_quote.

string

request_state

required

Lifecycle of the last quote request for this application (draft until one is made).

string

request_id

string

nullable

result

The carrier outcome of the last request

object

key

additional properties

any

allowed_actions

Array<string>

residual_pdf

State of any residual PDF forms Hedge still prepares outside the carrier applications (status, form_keys).

object

key

additional properties

any

Example

{
  "contract_version": "structured_v1",
  "facts": {
    "contract_version": "structured_v1",
    "owner_host": "hedge",
    "facts": [
      {
        "scope": "insured",
        "source": {
          "channel": "broker_portal",
          "evidence": "explicit"
        },
        "confirmed": false
      }
    ]
  },
  "applications": [
    {
      "owner_host": "hedge",
      "route": "hedge",
      "ownership": {
        "additionalProperty": {
          "kind": "explicit",
          "source": {
            "channel": "broker_portal",
            "evidence": "explicit"
          }
        }
      }
    }
  ]
}

404

Submission not found (or not your brokerage’s)