Skip to content
Hedge Developer Docs

Overview

Hedge Submission API 1.0

Section titled “Hedge Submission API 1.0”

Submit commercial insurance risks to Hedge programmatically and track them to quote. One rail, two doors:

  • Connected apps / broker agents, per-user OAuth 2.1 (PKCE, dynamic client registration). The broker consents once; tokens are scoped to their brokerage. This is also how the Hedge MCP connector works.
  • Systems (machine) credentials, brokerage API clients created self-serve in the broker portal (Settings → API keys) or issued by Hedge ops, exchanged via the client_credentials grant. Submissions made with a machine credential must name a producer_email.

The contract is gaps-driven: create a submission with minimal data, upload what you have, and read GET /broker/submissions/{id}/requirements for exactly what each matched market still needs. Answer carrier questions for instant-quote markets, then finalize to start marketing.

All endpoints are scoped to YOUR brokerage by the token, there is no cross-tenant access. Base URL: https://api.hedgespecialty.com/api/v1.

Changes are additive-only on this version. Breaking changes ship as a new version with notice to integrated partners.

Information

  • OpenAPI version: 3.1.0

Operations

Section titled “Operations”
POST
/oauth/register
GET
/oauth/authorize
POST
/oauth/device_authorization
POST
/oauth/token
GET
/broker/me
GET
/broker/submissions
POST
/broker/submissions
GET
/broker/submissions/{submission_id}
GET
/broker/submissions/{submission_id}/events
POST
/broker/submissions/{submission_id}/documents
POST
/broker/submissions/{submission_id}/finalize
GET
/broker/insureds
GET
/broker/insureds/{insured_id}
GET
/broker/forms
GET
/broker/forms/{form_key}/pdf
GET
/broker/submissions/{submission_id}/requirements
GET
/broker/markets/{market_id}/requirements
GET
/broker/submissions/{submission_id}/api-quotes/sessions
POST
/broker/submissions/{submission_id}/api-quotes/sessions/{session_id}/answers
POST
/broker/submissions/{submission_id}/api-quotes/sessions/{session_id}/close
GET
/broker/submissions/{submission_id}/finalized-documents
GET
/broker/finalized-documents/{document_id}/pdf
GET
/broker/policies
GET
/broker/policies/{policy_id}
GET
/broker/policies/{policy_id}/document/{kind}
GET
/broker/appetite
GET
/broker/payments
GET
/broker/market-access
PUT
/broker/market-access
PUT
/broker/market-access/program
PUT
/broker/market-access/program-line

Authentication

Section titled “Authentication”

brokerOAuth

Section titled “brokerOAuth”

Broker access token. Scopes: broker_mcp (read), broker_submit (write). Per-user tokens come from the OAuth authorization-code + PKCE flow (/oauth/authorize → /oauth/token); machine tokens from client_credentials, using an API key created self-serve in the broker portal (Settings → API keys) or issued by Hedge ops. Access tokens live 60 minutes.

Security scheme type: http