> ## Documentation Index
> Fetch the complete documentation index at: https://docs.signsealship.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Register a passport webhook

> Register an https endpoint for `passport.sealed` events using your partner API key. The signing secret is returned exactly once — only its hash is stored. Subscriptions created this way receive only `passport.sealed` (no room events).



## OpenAPI

````yaml /api-reference/openapi.json post /api/passport/webhooks
openapi: 3.1.0
info:
  title: SignSealShip Partner API
  version: 1.0.0
  description: >-
    The SignSealShip partner API: create sign / notarize / ship orders, create
    Verified Closing Rooms, seal Closing Passports and Proof Passports, and
    manage webhooks. Partner endpoints authenticate with a bearer key
    (`Authorization: Bearer sss_pk_...`); public verification endpoints need no
    key — possession of the verify, room, or order code is the authorization.
    See the Guides for full prose, rate limits, and signature verification.
  contact:
    name: SignSealShip
    url: https://signsealship.com/partner
servers:
  - url: https://signsealship.com
    description: Production
security:
  - partnerKey: []
tags:
  - name: Onboarding
    description: Request partner API access.
  - name: Orders
    description: >-
      B2B order intake — create sign / notarize / ship orders, track them, and
      mint Stripe hosted checkout.
  - name: Sandbox
    description: >-
      Deterministic lifecycle simulation for TEST orders (sss_pk_test_ keys) —
      real state machine, real signed webhooks, no live money.
  - name: Launchpad & Analytics
    description: Your workspace's go-live checklist and tenant-scoped analytics.
  - name: Closing Rooms
    description: Verified Closing Rooms — one shareable page per transaction.
  - name: Closing Passports
    description: Room-level, hash-chained, KMS-sealed evidence manifests.
  - name: Proof Passport
    description: Seal and verify a single executed PDF.
  - name: Webhooks
    description: Signed event delivery and subscription management.
paths:
  /api/passport/webhooks:
    post:
      tags:
        - Webhooks
      summary: Register a passport webhook
      description: >-
        Register an https endpoint for `passport.sealed` events using your
        partner API key. The signing secret is returned exactly once — only its
        hash is stored. Subscriptions created this way receive only
        `passport.sealed` (no room events).
      requestBody:
        required: true
        content:
          application/json:
            schema:
              type: object
              required:
                - url
              properties:
                url:
                  type: string
                  format: uri
                  description: Your https webhook endpoint.
            example:
              url: https://example.com/hooks/signsealship
      responses:
        '200':
          description: Webhook registered.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PassportWebhookResponse'
        '401':
          $ref: '#/components/responses/Unauthorized'
components:
  schemas:
    PassportWebhookResponse:
      type: object
      properties:
        webhookId:
          type: string
          format: uuid
        url:
          type: string
        signingSecret:
          type: string
          description: Shown exactly once — store it now. Only its hash is kept.
        signatureHeader:
          type: string
          example: SignSealShip-Signature
        verification:
          type: string
          description: How to verify the HMAC signature.
    Error:
      type: object
      properties:
        error:
          type: string
  responses:
    Unauthorized:
      description: Missing, malformed, revoked, or unknown partner key.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error: A valid partner API key is required.
  securitySchemes:
    partnerKey:
      type: http
      scheme: bearer
      bearerFormat: sss_pk_...
      description: 'Partner API key. Send as `Authorization: Bearer sss_pk_...`.'

````

This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.