> ## 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.

# Read the room (public)

> Public read by possession of the room code — no API key. The same live JSON the room page renders. Codes outside the 24–64 character gate and unknown codes both return an empty 404. Responses are `Cache-Control: no-store`.



## OpenAPI

````yaml /api-reference/openapi.json get /api/rooms/{roomCode}
openapi: 3.1.0
info:
  title: SignSealShip Partner API
  version: 1.0.0
  description: >-
    The SignSealShip partner API: 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: 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/rooms/{roomCode}:
    get:
      tags:
        - Closing Rooms
      summary: Read the room (public)
      description: >-
        Public read by possession of the room code — no API key. The same live
        JSON the room page renders. Codes outside the 24–64 character gate and
        unknown codes both return an empty 404. Responses are `Cache-Control:
        no-store`.
      parameters:
        - $ref: '#/components/parameters/RoomCode'
      responses:
        '200':
          description: The live room view.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RoomView'
        '404':
          description: Unknown or malformed room code.
      security: []
components:
  parameters:
    RoomCode:
      name: roomCode
      in: path
      required: true
      schema:
        type: string
      description: >-
        The room's bearer code (40 lowercase hex characters; the read endpoint
        accepts 24–64).
  schemas:
    RoomView:
      type: object
      properties:
        roomCode:
          type: string
        name:
          type: string
        reference:
          type:
            - string
            - 'null'
        status:
          type: string
          example: open
        partnerName:
          type: string
        branding:
          $ref: '#/components/schemas/Branding'
        progress:
          type: object
          properties:
            total:
              type: integer
            signed:
              type: integer
            sealed:
              type: integer
            delivered:
              type: integer
        orders:
          type: array
          items:
            $ref: '#/components/schemas/RoomOrderCard'
        activity:
          type: array
          items:
            $ref: '#/components/schemas/ActivityItem'
        passport:
          $ref: '#/components/schemas/RoomPassportInfo'
        createdAt:
          type: string
          format: date-time
        updatedAt:
          type: string
          format: date-time
    Branding:
      type:
        - object
        - 'null'
      properties:
        brandName:
          type:
            - string
            - 'null'
        accentColor:
          type:
            - string
            - 'null'
          description: Hex color like `#1a2b3c`.
        logoUrl:
          type:
            - string
            - 'null'
          description: Public https URL of the partner's logo.
    RoomOrderCard:
      type: object
      properties:
        orderCode:
          type: string
        label:
          type:
            - string
            - 'null'
        status:
          type: string
          description: >-
            Raw platform status (e.g. `EsignPending`). Build logic on
            `statusGroup`.
        statusGroup:
          type: string
          enum:
            - signing
            - signed
            - notarizing
            - notarized
            - shipping
            - shipped
            - delivered
            - complete
            - attention
            - open
        services:
          type: object
          properties:
            sign:
              type: boolean
            notarize:
              type: boolean
            ship:
              type: boolean
        signers:
          type: array
          items:
            type: object
            properties:
              email:
                type: string
                description: Masked email.
              name:
                type:
                  - string
                  - 'null'
              routingOrder:
                type: integer
              signed:
                type: boolean
        evidenceBadge:
          type: string
          enum:
            - sealed
            - recorded
            - none
          description: >-
            Locked vocabulary: `sealed` (verifiable artifact hash on record),
            `recorded` (platform attestation only), `none` (no evidence yet).
        verifyCode:
          type:
            - string
            - 'null'
          description: >-
            Present only when the badge is `sealed` and the envelope verify code
            exists.
        trackingNumber:
          type:
            - string
            - 'null'
        carrier:
          type:
            - string
            - 'null'
        attachedAt:
          type: string
          format: date-time
    ActivityItem:
      type: object
      properties:
        orderCode:
          type: string
        action:
          type: string
          enum:
            - order.created
            - order.transition
            - order.claimed
            - order.cancelled
            - signing_link.issued
            - room.order_attached
        fromStatus:
          type:
            - string
            - 'null'
        toStatus:
          type:
            - string
            - 'null'
        occurredAt:
          type: string
          format: date-time
    RoomPassportInfo:
      type:
        - object
        - 'null'
      properties:
        version:
          type: integer
        verifyCode:
          type: string
        createdAt:
          type: string
          format: date-time
  securitySchemes:
    partnerKey:
      type: http
      scheme: bearer
      bearerFormat: sss_pk_...
      description: 'Partner API key. Send as `Authorization: Bearer sss_pk_...`.'

````