Submissions

Create a submission from documents and/or text (the portal's Upload documents)

Changed on

The API form of the portal's Upload documents. Send free text (an email body, notes), documents (ACORDs, loss runs, supplements), or both. Hedge reads them as the portal does (the insured, address, NAICS, lines, effective date, locations), prefills a structured file for Hedge Instant Quote markets only and returns the same response as POST /broker/submissions: each market's state. Your typed fields win over what Hedge read. Emails follow your brokerage's notification settings; the defaults match the portal. The documents stay on the file and keep feeding its prefill; identical files in one call are stored once.

When what Hedge read fits no instant market (or names no lines or state) it returns 422 no_instant_market (or missing_core) with email_us and read (what it could read), and creates nothing.

Requires text, insured_name or documents. Machine credentials must name producer_email. client_reference and an Idempotency-Key header make a retry return the saved file. Counts toward the daily upload limit.

post/broker/intake

Request

  • Base URL
    https://api.hedgespecialty.com/api/v1
  • Auth
    OAuth 2
    Authorization code: https://api.hedgespecialty.com/api/v1/oauth/authorize
    Client credentials
    Token URL: https://api.hedgespecialty.com/api/v1/oauth/token

Headers

Idempotency-Keystring

Request body multipart/form-data

textstring

The risk as you would describe it in an email. Required unless insured_name is given.

filesstring[]

Up to 20 PDFs (ACORDs, loss runs, supplements), 15 MB each.

insured_namestring
effective_datestring date
lines_of_businessstring

Comma-separated canonical slugs or common aliases (e.g. gl,property).

primary_statestring

Primary risk state, 2-letter US code.

producer_emailstring

REQUIRED when authenticating with a machine credential; the active portal user this submission is attributed to.

holdboolean

Accepted and changes nothing for a connected app or machine credential.

program_idsstring

Comma-separated Hedge Instant Quote program ids (default every one that fits).

client_referencestring

Your reference; unique per brokerage (a repeat returns that file, 200).

quoteboolean

Quote each market as soon as it is ready.

Response

Created; each instant market's state.

submission_idstring uuid required
statestring
status_labelstring required
marketing_status'matching' | 'awaiting_finalization' | 'null' nullable

Null for an instant-flow file (it never starts marketing).

next_stepstring required
client_referencestring nullable
automatic_quotingboolean nullable
warningsstring[]

Non-fatal notices (a file that was not stored, a background enqueue that needs attention, a replayed request).

portal_urlstring uri required

Changes

    • breaking

      the response property became nullable for the status

    • breaking

      the response property became optional for the status

    • warning

      added the new undefined enum value to the response property for the response status

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the new optional request property

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status

    • info

      endpoint added