Hedge Policies API

openapi: 3.2.0
info:
  title: Hedgespecialty Com Policies API
  version: '1.0'
  description: 'Operations tagged Policies across 2 of this provider''s published API definitions: hedge-openapi.json, hedgespecialty-com-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.hedgespecialty.com/api/v1
  description: Production
- url: https://staging-api.hedgespecialty.com/api/v1
  description: Staging sandbox
security:
- brokerOAuth: []
tags:
- name: Policies
paths:
  /broker/policies:
    get:
      tags:
      - Policies
      operationId: listPolicies
      summary: List your brokerage's bound policies
      description: 'One row per policy: policy_number, carrier_name, status +

        status_label, premium, effective and expiration dates, and the

        source submission_id.'
      responses:
        '200':
          description: Policy list
          newest effective date first: null
    servers:
    - url: https://api.hedgespecialty.com/api/v1
      description: Production
    - url: https://staging-api.hedgespecialty.com/api/v1
      description: Staging sandbox
  /broker/policies/{policy_id}:
    get:
      tags:
      - Policies
      operationId: getPolicy
      summary: Get one policy
      description: 'Full policy detail: identifiers, coverage lines, term, carrier and

        underwriting paper (with NAIC code and admitted status), the premium

        breakdown (net premium, fees, taxes, total billed), YOUR commission

        (rate and amount), payment terms, and the downloadable documents

        (binder, policy, declarations) with their download paths.'
      parameters:
      - in: path
        name: policy_id
        required: true
        schema:
          type: string
          format: uuid
      responses:
        '200':
          description: Policy detail
        '404':
          description: Not found (or not your brokerage's)
    servers:
    - url: https://api.hedgespecialty.com/api/v1
      description: Production
    - url: https://staging-api.hedgespecialty.com/api/v1
      description: Staging sandbox
  /broker/policies/{policy_id}/document/{kind}:
    get:
      tags:
      - Policies
      operationId: downloadPolicyDocument
      summary: Download a policy document PDF
      description: Streams the binder, policy, or declarations PDF, brokerage-scoped.
      parameters:
      - in: path
        name: policy_id
        required: true
        schema:
          type: string
          format: uuid
      - in: path
        name: kind
        required: true
        schema:
          type: string
          enum:
          - binder
          - policy
          - declarations
      responses:
        '200':
          description: The PDF bytes (or a 307 redirect to hosted storage)
          content:
            application/pdf: {}
        '404':
          description: Policy or document not found
        '502':
          description: Stored document could not be retrieved
    servers:
    - url: https://api.hedgespecialty.com/api/v1
      description: Production
    - url: https://staging-api.hedgespecialty.com/api/v1
      description: Staging sandbox
components:
  securitySchemes:
    brokerOAuth:
      type: oauth2
      description: '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.

        '
      flows:
        authorizationCode:
          authorizationUrl: https://api.hedgespecialty.com/api/v1/oauth/authorize
          tokenUrl: https://api.hedgespecialty.com/api/v1/oauth/token
          scopes:
            broker_mcp: Read brokerage-scoped submissions, policies, payments, appetite, and requirements.
            broker_submit: Create submissions, answer Hedge's asks, and act on quotes for your brokerage.
        clientCredentials:
          tokenUrl: https://api.hedgespecialty.com/api/v1/oauth/token
          scopes:
            broker_mcp: Read brokerage-scoped submissions, policies, payments, appetite, and requirements.
            broker_submit: Create submissions, answer Hedge's asks, and act on quotes for your brokerage.
externalDocs:
  description: Hedge developer documentation
  url: https://docs.hedgespecialty.com
x-refined-from:
- hedge-openapi.json
- hedgespecialty-com-openapi.yml