Submissions

Release a held submission

Changed on

A file a connected app or machine credential created quotes Hedge Instant Quote markets only and has nothing to release: this returns 409 use_quote for it (answer with PATCH .../answers, request quotes with POST .../quote).

Starts the run for a submission created with hold: true (or with an expected-documents manifest): Hedge matches carrier markets, sends the clearance email to the producer, opens the lanes and quotes the instant-quote markets. Idempotent — on a submission whose run already started (a default create, or an earlier finalize) it returns the same 202 without starting anything twice.

Matching is asynchronous; it usually completes within about 5 minutes (typical_wait_seconds). Poll GET /broker/submissions/{id}/markets for the three categories, or the requirements endpoint, whose marketing_status flips to matched when lanes attach and distinguishes still-matching from no-appetite.

A mode: rater submission (partner integrations) instead opens its chosen programs synchronously: marketing_status is quoting with lanes and not_opened (each program's reasons), or closed when none of them can quote. A 422 rater_start_failed leaves the file held (for example, no requested line or risk state could be read).

post/broker/submissions/{submission_id}/finalize

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

Queued; matching runs asynchronously.

statusstring
marketing_statusstring
typical_wait_secondsinteger
detailstring

Example response

{
  "status": "queued",
  "marketing_status": "matching",
  "typical_wait_seconds": 300
}

Changes