Requirements

What this submission still needs

Changed on

The contract centerpiece, per-market readiness (needs_from_you = items only you can supply), live carrier question gaps, the resolved form set, and documents already on file. Deterministic and fast; poll it between uploads/answers and finalize.

get/broker/submissions/{submission_id}/requirements

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

Path parameters

submission_idstring uuid required

Response

Requirements view

submission_idstring uuid
insured_namestring
linesstring[]
effective_datestring date
statestring
formsstring[]

Application forms Hedge prepares for this risk (ACORD baseline + recommended carrier supplements).

marketing_status'not_started' | 'matching' | 'matched' | 'no_markets_matched' | 'awaiting_finalization' | 'instant_quote'

Where the asynchronous marketing pipeline is. Matching runs for a few minutes after finalize, so an empty markets list means "still matching" when this is matching; not "no appetite". instant_quote: a file a connected app or machine credential created, which is never marketed or finalized; answer it with PATCH .../answers and request quotes with POST .../quote.

marketing_hintstring nullable

Human-readable next step for the current marketing_status.

form_fill_activeboolean

A live form-fill session owns the form set.

Example response

{
  "markets": [
    {
      "category_label": "Hedge Instant Quote"
    }
  ]
}

Changes

    • warning

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

    • warning

      added the new instant_quote enum value to the response property for the response 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