Partner API surface

These catalog events wire into growthEngine / referral compounders when stub-delivered from /partners/webhooks.

• waitlist.signup

  Waitlist signup

• referral.attributed

  Referral attributed

• quote.requested

  Quote requested

• intent.opted_in

  Intent opted in

• partner.interest

  Partner interest

• coverage.gap_reported

  Coverage gap reported

OpenAPI-style stub (0.2.0-stub)

{
  "openapi": "3.0.3",
  "info": {
    "title": "Parity Partner API (stub)",
    "version": "0.2.0-stub",
    "description": "Demo partner API only — auth keys, rate limits, and payloads are illustrative stubs. No live HTTP partner backend, signing, or metering in this build. See /partners/api and /api/v1/openapi.json."
  },
  "servers": [
    {
      "url": "https://parity.demo/api/v1/partners",
      "description": "Illustrative partner host"
    }
  ],
  "components": {
    "securitySchemes": {
      "PartnerApiKey": {
        "type": "apiKey",
        "in": "header",
        "name": "X-Parity-Partner-Key",
        "description": "Stub API key — paste into docs examples only. This demo never validates keys server-side; localStorage billing plan “partner” is the soft-paywall hint."
      }
    }
  },
  "security": [
    {
      "PartnerApiKey": []
    }
  ],
  "x-parity-rate-limits": {
    "requestsPerMinute": 60,
    "burst": 10,
    "dailySoftCap": 5000,
    "headers": {
      "remaining": "X-RateLimit-Remaining",
      "reset": "X-RateLimit-Reset",
      "limit": "X-RateLimit-Limit"
    },
    "blurb": "Illustrative partner rate limits — not enforced in the browser demo. Future live API will return 429 with these headers."
  },
  "paths": {
    "/intents": {
      "post": {
        "operationId": "createIntent",
        "summary": "Create shaped intent (stub)",
        "description": "UNIMPLEMENTED STUB. Future: partner submits anonymized, consenting intent (ZIP, line, timeline). Maps to intent.opted_in webhook.",
        "x-parity-status": "unimplemented-stub",
        "x-parity-webhook": "intent.opted_in",
        "responses": {
          "501": {
            "description": "Not implemented — stub only",
            "content": {
              "application/json": {
                "example": {
                  "id": "intent_stub_01HZXDEMO",
                  "status": "accepted_stub",
                  "type": "intent.create",
                  "webhook": "intent.opted_in",
                  "created_at": "2026-09-27T18:00:00.000Z",
                  "data": {
                    "line": "auto",
                    "zip": "75201",
                    "score": 84,
                    "affiliate_code": "AGENCY-DFW"
                  }
                }
              }
            }
          }
        }
      }
    },
    "/quotes/{quoteId}/status": {
      "get": {
        "operationId": "getQuoteStatus",
        "summary": "Quote status (stub)",
        "description": "UNIMPLEMENTED STUB. Future: poll illustrative quote lifecycle (requested → quoted → expired). Sample mirrors quote.requested webhook data.",
        "x-parity-status": "unimplemented-stub",
        "x-parity-webhook": "quote.requested",
        "responses": {
          "501": {
            "description": "Not implemented — stub only",
            "content": {
              "application/json": {
                "example": {
                  "id": "quote_stub_01HZXDEMO",
                  "status": "requested",
                  "type": "quote.status",
                  "updated_at": "2026-09-27T18:05:00.000Z",
                  "data": {
                    "line": "auto",
                    "zip": "75201",
                    "timeline": "30d",
                    "parity_context": "better_cheaper",
                    "quality_band": "strong",
                    "sla_hours_remaining": 3.5
                  }
                }
              }
            }
          }
        }
      }
    },
    "/referrals/attributed": {
      "post": {
        "operationId": "emitReferralAttributed",
        "summary": "Referral attributed (stub)",
        "description": "UNIMPLEMENTED STUB. Future: partners post or receive referral.attributed when a landing / waitlist signup compounds. Wired to growthEngine attribution drafts in-demo.",
        "x-parity-status": "unimplemented-stub",
        "x-parity-webhook": "referral.attributed",
        "responses": {
          "501": {
            "description": "Not implemented — stub only",
            "content": {
              "application/json": {
                "example": {
                  "id": "evt_ref_stub_01HZXDEMO",
                  "type": "referral.attributed",
                  "status": "logged_stub",
                  "created_at": "2026-09-27T18:10:00.000Z",
                  "data": {
                    "code": "PARITY-DFW",
                    "channel": "affiliate",
                    "landing": "/growth",
                    "attributed_to": "waitlist.signup",
                    "metro": "Dallas–Fort Worth"
                  }
                }
              }
            }
          }
        }
      }
    }
  }
}