Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.0xkey.io/llms.txt

Use this file to discover all available pages before exploring further.

The implementation status of every endpoint is tracked on the Roadmap. Endpoints listed in the API reference may be wired but stubbed in Phase 1 — always check the Roadmap before designing an integration.

​
RPC/HTTP

We chose RPC-over-HTTP for convenience and ease-of-use. Most of our users should be able to integrate with our API without a major re-architecture of their existing systems. Many client libraries are available to make requests to a RPC/HTTP API, across many languages. 0xkey will provide SDKs for the most popular programming languages. For other languages, a RPC/HTTP API ensures there is an easy integration path available via raw http clients.

​
POST-only

If you look at the API reference you’ll notice that all API calls to 0xkey are HTTP POST requests. Requests contain a POST body and a header with a digital signature over the POST body. We call this digital signature a Stamp. Requests must be stamped by registered user credentials and verified by 0xkey’s secure enclaves before they are processed. This ensures cryptographic integrity end-to-end which eliminates the ability for any party to modify a user’s request.

​
Queries and submissions

0xkey’s API is divided into 2 broad categories: queries and submissions.
  • Queries are read requests (e.g. get_users, list_users)
  • Submissions are requests to execute a workload (e.g. create_policy, sign_transaction, delete_user)

​
Dive deeper