Authorization: Bearer sss_pk_...) and share the partner-write limit of 60 requests per minute per key. The public room view is rate limited at 30 requests per minute per IP. See authentication.
Create a room
POST /api/rooms
Room creation enforces your tier’s active-room quota (trial and PartnerLink: 5 open rooms; ProOffice: 25; ClosingDesk: unlimited).
Display name for the room, 1–200 characters. Shown to every party who opens
the link — a property address or matter name works well.
The room’s bearer code — 40 lowercase hex characters, minted from a CSPRNG.
This is the credential in the room link.
Root-relative path to the shareable page,
/rooms/{roomCode}. Prefix it
with https://signsealship.com before sharing.200 OK
400 with {"error": "A room name (1–200 chars) is required."} for a missing or oversized name, or a quota message such as "Active-room quota reached (5 open rooms on the None tier). Close a room or upgrade your plan to create more."
List your rooms
GET /api/rooms
Returns your own rooms only, newest first.
Attach an order
POST /api/rooms/{roomCode}/orders
Attach authorization is possession of the order’s public code: a partner who holds the code may bind that order to their room. Attaching is idempotent — re-attaching an already attached order succeeds with alreadyAttached: true. A room holds at most 50 orders.
400 {"error": "A valid orderCode is required."} (bad length), 400 {"error": "A room holds at most 50 orders."}, 404 {"error": "Room not found."} or {"error": "Order not found."} — unknown codes read as a generic not-found.
Detach an order
DELETE /api/rooms/{roomCode}/orders/{orderCode}
curl
{"ok": true}, or 404 with {"error": "Room not found."}, {"error": "Order not found."}, or {"error": "That order is not in this room."}.
Rotate the room link
POST /api/rooms/{roomCode}/rotate
Reissues the room’s bearer code. Every previously shared room link dies instantly — this is the mitigation for a leaked or over-shared link. The public view is served with Cache-Control: no-store, so a rotated code dies at every cache layer too.
404 {"error": "Room not found."} for a code that is not one of your rooms.
Per-party scoped links (separate credentials per participant) are on the
roadmap; today one room has one link.
Read the room (public)
GET /api/rooms/{roomCode}
Public read by possession of the room code — no API key, no account. This is the same live JSON the room page at /rooms/{roomCode} renders, for your own systems. Codes outside the 24–64 character gate and unknown codes both return an empty 404. Responses are Cache-Control: no-store.
Statuses are database truth read at request time. Evidence badges never claim more than the record holds.
Response shape
The partner’s public branding, or
null when none is set. Rendered as
attribution (“Presented by …”) beside the permanent SignSealShip mark —
never replacing it.Merged timeline across all attached orders — up to 100 items, newest first,
derived from an explicit allowlist of audit actions:
order.created,
order.transition, order.claimed, order.cancelled,
signing_link.issued, room.order_attached. No recipient identifiers or
actor details are ever included.The room’s latest Closing Passport, or
null until one is sealed. This is
only a pointer — verification always goes through the
public verify surface, which recomputes the
chain.200 OK (abridged)