Rox
Register · Developers
PUBLIC DOCS
v1 · api.roxregister.com
Sign in to Platform
OverviewQuickstartsGuidesSDKsAPI referenceErrorsWebhooksJWS vectors
Seal anything. Prove everything.
Hash your documents client-side, seal the digest on RoxChain, and hand anyone a proof they can verify without trusting you, or us. The document itself never leaves your systems.
These docs are public, anyone can read and plan an integration. API keys are created inside your Platform, by your team, scoped to a single vault. There is no public signup for keys.
Quickstarts
Seal a digest, verify a record, receive signed webhooks, copy-paste snippets in curl, Node and Python that match the live API contract exactly.
3 quickstarts · curl · Node · Python
Guides
Walkthroughs of the flows that matter: your first seal end to end, sealing and stamping a PDF, consuming signed webhooks reliably, and selective disclosure with salted field hashes.
first seal · stamping · webhooks · selective disclosure
SDKs
Official clients for Node.js and Python: request signing, retries, local hashing, selective disclosure and webhook verification built in.
@rox-register/sdk · pip rox-register
API reference
Generated from the live API contract: sealing, records, vault keys and the public verify plane, with auth, scopes, JWS requirements and errors per endpoint.
machine + verify planes
Error codes
Typed, stable RR-codes on RFC 7807 problem+json responses. What each one means and what to fix.
RR-1001 … RR-5xxx
Webhook events
The full event catalogue, the delivery envelope, the HMAC signature formula and the retry schedule.
13 events · v1=HMAC-SHA256
JWS test vectors
Golden vectors for the RRv1 request-signing canonical string, empty, unicode and binary bodies included. Wire them into your test suite before you ship.
6 vectors · Ed25519 + P-256
Two keys, two jobs
The API key says which vault you may talk to; the detached JWS on every mutation proves the request came from you and was not altered. Rox cannot anchor in your name without it.
RRv1\n{method}\n{path}\n{sha256_hex(body)}\n{ts}\n{nonce}
Get API access
API keys are created inside your Platform by your team, scoped to a single vault, with explicit scopes. There is no public signup for keys.
Sign in to Platform →
Verify without an account
Verification is public by design. Anyone with a verify link or QR can check a record at registry3.pebe.io, and the verify API needs no key and no login.
Verify plane reference →
Ship with the SDKs
The Node and Python SDKs handle request signing, retries, local hashing and webhook verification, so your integration is a few lines, not a protocol implementation.
SDK documentation →