Broker Get Submission

GET

/api/v1/broker/submissions/{submission_id}

curl --request GET \
  --url https://example.com/api/v1/broker/submissions/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0

Parameters

Path Parameters

submission_id

required

Submission Id

string format: uuid

Responses

200

Successful Response

Media typeapplication/json

BrokerSubmissionDetail

object

id

required

Id

string format: uuid

insured_name

Any of:

string

string

null

null

lines

Lines

Array<string>

state

Any of:

string

string

null

null

status_label

required

Status Label

string

premium

Any of:

string

string

null

null

primary_state

Any of:

string

string

null

null

created_at

required

Created At

string format: date-time

updated_at

required

Updated At

string format: date-time

bor_actions

Bor Actions

Array<object>

BrokerBorAction

One Broker-of-Record workstream on the submission, broker-facing.

Rendered as the “BOR needed” card: a carrier told us another broker already holds the account, and (when bor_viable) a signed letter from the insured, produced on the retail side, never by Hedge - unblocks it. Naming the carrier here is deliberate: the insured has to sign a letter naming that carrier, so anonymized market language is useless to the broker.

object

id

required

Id

string format: uuid

status

required

Status

string

carrier_name

required

Carrier Name

string

lob_slugs

Lob Slugs

Array<string>

bor_viable

Bor Viable

boolean

default: true

viability_note

Any of:

string

string

null

null

insured_letterhead

Insured Letterhead

boolean

reference_policy_number

Reference Policy Number

boolean

other_requirements

Any of:

string

string

null

null

carrier_reference

Any of:

string

string

null

null

incumbent_broker_name

Any of:

string

string

null

null

countermand_window_days

Any of:

integer

integer

null

null

letter_received_at

Any of:

string

string format: date-time

null

null

letter_sent_to_carrier_at

Any of:

string

string format: date-time

null

null

expected_release_at

Any of:

string

string format: date-time

null

null

resolved_at

Any of:

string

string format: date-time

null

null

signed_document_id

Any of:

string

string format: uuid

null

null

created_at

required

Created At

string format: date-time

Example

{
  "bor_actions": [
    {
      "bor_viable": true,
      "insured_letterhead": false,
      "reference_policy_number": false
    }
  ]
}

422

Validation Error

Media typeapplication/json

HTTPValidationError

object

detail

Detail

Array<object>

ValidationError

object

loc

required

Location

Array

msg

required

Message

string

type

required

Error Type

string

Example^generated

{
  "detail": [
    {
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example"
    }
  ]
}