Skip to content

One carrier application from the workspace

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

One carrier application, presented exactly as the application-workspace read presents it, so a client can refresh a single application after a changed event. session_id is the ApplicationSection.application_id. 404 with code: read_workspace means read the whole workspace instead: the application is a Hedge or legacy application, its session was withdrawn, or it is outside the selected quoting scope. Read scope is enough.

submission_id
required
string format: uuid
session_id
required
string format: uuid

The application

Media typeapplication/json
object
application
required

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>
Example
{
"application": {
"owner_host": "hedge",
"route": "hedge",
"ownership": {
"additionalProperty": {
"kind": "explicit",
"source": {
"channel": "broker_portal",
"evidence": "explicit"
}
}
}
}
}

Submission not found (or not your brokerage’s), or code: read_workspace