API reference
QuantLayer API 0.1.0, generated from the OpenAPI document the API serves at /openapi.json. Request and response schemas are in that document.
Conventions
- Authentication
- Authorization: Bearer quantlayer_sk_… for API keys; wallet sessions use quantlayer_ss_… tokens.
- Errors
- { error: { code, message, reason?, requestId, details? } } with the HTTP status.
- Bytes and times
- base64url without padding; ISO 8601 timestamps; Unix seconds inside signed protocol objects.
- Rate limits
- 429 with Retry-After when exceeded.
Operations
| Endpoint | Purpose | Access |
|---|---|---|
| GET /health | Liveness | Public |
| GET /health/ready | Readiness: database and Redis reachable | Public |
| GET /metrics | Prometheus metrics | Public |
| GET /openapi.json | OpenAPI 3.1 document for this API | Public |
Identity
| Endpoint | Purpose | Access |
|---|---|---|
| POST /v1/admin/identities/{did}/{action} | Operator lifecycle action (activate, suspend, reinstate) | Administrator |
| POST /v1/identities | Create a did:quantlayer identity (self-certifying, proof of possession) | API key |
| GET /v1/identities/{did} | Resolve an identity (public projection) | API key |
| POST /v1/identities/{did}/accounts | Link a wallet account (EIP-712 ownership proof) | API key |
| POST /v1/identities/{did}/accounts/unlink | Unlink a wallet account | API key |
| POST /v1/identities/{did}/deactivate | Deactivate an identity (terminal) | API key |
| POST /v1/identities/{did}/keys | Register a new verification method | API key |
| POST /v1/identities/{did}/keys/revoke | Revoke a key version | API key |
| POST /v1/identities/{did}/keys/rotate | Rotate a verification method (the algorithm may change, e.g. Ed25519 → ML-DSA-65) | API key |
| POST /v1/identities/challenges | Issue a single-use challenge for an identity operation | API key |
Developer
| Endpoint | Purpose | Access |
|---|---|---|
| POST /v1/admin/projects/{projectId}/plan | Assign a project's subscription plan (administrator) | Administrator |
| POST /v1/admin/projects/{projectId}/status | Suspend or reactivate a project (administrator) | Administrator |
| DELETE /v1/auth/session | Sign out (revoke the current session) | Wallet session |
| GET /v1/auth/session | Current wallet session | Wallet session |
| POST /v1/auth/wallet/challenge | Start wallet sign-in (EIP-712) | Public |
| POST /v1/auth/wallet/verify | Finish wallet sign-in and create a session | Public |
| GET /v1/developer/projects | List the signed-in wallet's projects | Wallet session |
| POST /v1/developer/projects | Create a project owned by the signed-in wallet | Wallet session |
| GET /v1/developer/projects/{projectId}/api-keys | List a project's API keys (no secrets) | Wallet session |
| POST /v1/developer/projects/{projectId}/api-keys | Create an API key (the secret is returned once) | Wallet session |
| DELETE /v1/developer/projects/{projectId}/api-keys/{keyId} | Revoke an API key | Wallet session |
| GET /v1/developer/projects/{projectId}/audit-events | A project's audit trail (newest first) | Wallet session |
| GET /v1/developer/projects/{projectId}/usage | A project's metered usage: plan, quota for the current period and daily counts | Wallet session |
| GET /v1/developer/whoami | Describe the calling API key | API key |
Authorization
| Endpoint | Purpose | Access |
|---|---|---|
| GET /v1/authorization/capabilities | Authorization modes and signature algorithms this server accepts | Public |
| POST /v1/authorization/decisions | Decide an authorization request | API key |
| POST /v1/authorization/policies | Publish a verification policy version (immutable) | API key |
| POST /v1/authorization/policies/{policyId}/minimum-version | Retire older policy versions | API key |
| POST /v1/authorization/revocations | Emergency revocation of a key version (`keyId@version`) or a request id | API key |
Blockchain
| Endpoint | Purpose | Access |
|---|---|---|
| GET /v1/blockchain/credential-status/{issuerId}/{credentialIdHash} | Indexed on-chain credential status (QuantLayerCredentialRegistry) | API key |
| GET /v1/blockchain/network | Chain, head, configured QuantLayer contracts and indexer progress | API key |
| POST /v1/blockchain/transactions | Track a submitted transaction | API key |
| GET /v1/blockchain/transactions/{id} | Tracked transaction status | API key |
Credentials
| Endpoint | Purpose | Access |
|---|---|---|
| POST /v1/credentials/external/verify | Verify an external credential or Verifiable Presentation | API key |
| POST /v1/credentials/issuers | Register an issuer (did:quantlayer identity with a post-quantum custody key) | API key |
| GET /v1/credentials/issuers/{issuerId} | Get an issuer | API key |
| POST /v1/credentials/issuers/{issuerId}/credentials | Issue a selectively disclosable credential (quantlayer.credential/2) | API key |
| GET /v1/credentials/issuers/{issuerId}/credentials/{credentialId} | Issued-credential record and its status history (no claim values) | API key |
| POST /v1/credentials/issuers/{issuerId}/credentials/{credentialId}/{action} | Revoke, suspend or reinstate a credential (republishes the signed status list) | API key |
| POST /v1/credentials/presentations/verify | Verify a holder presentation | API key |
| GET /v1/credentials/status-lists/{listId} | Latest signed status list snapshot (public) | Public |
Privacy
| Endpoint | Purpose | Access |
|---|---|---|
| GET /v1/privacy/nullifiers/{scope}/{nullifier} | Whether a nullifier has been spent in a scope | API key |
| POST /v1/privacy/trees | Create a commitment tree (Poseidon-BN254, depth 20) | API key |
| GET /v1/privacy/trees/{treeId} | Tree metadata and current root | API key |
| POST /v1/privacy/trees/{treeId}/leaves | Append a commitment leaf | API key |
| POST /v1/privacy/trees/{treeId}/leaves/{index}/remove | Revoke a leaf (zeroed; the slot is never reused) | API key |
| GET /v1/privacy/trees/{treeId}/proofs/{index} | Merkle membership path for a leaf | API key |
| POST /v1/privacy/trees/{treeId}/publish | Publish the current root to the root registry | API key |
Proofs
| Endpoint | Purpose | Access |
|---|---|---|
| GET /v1/proofs/capabilities | Proof systems this server supports (versions from the committed circuit manifest) | Public |
| GET /v1/proofs/jobs/{jobId} | Proof job status and result | API key |
| POST /v1/proofs/jobs/prove | Queue delegated proving (the witness is sealed before it is queued) | API key |
| POST /v1/proofs/jobs/verify | Queue verification of a proof against a request | API key |
| POST /v1/proofs/requests | Create a proof request (verifier side) | API key |
Quantum
| Endpoint | Purpose | Access |
|---|---|---|
| POST /v1/quantum/keys | Generate a post-quantum key in custody | API key |
| GET /v1/quantum/keys/{name} | Public key ring (all versions) | API key |
| POST /v1/quantum/keys/{name}/rotate | Rotate, or migrate to another algorithm of the same kind | API key |
| POST /v1/quantum/keys/{name}/sign | Sign with the active version | API key |
| POST /v1/quantum/keys/{name}/versions/{version}/decapsulate | ML-KEM decapsulation with a custody key | API key |
| POST /v1/quantum/keys/{name}/versions/{version}/revoke | Revoke a key version (terminal; its sealed secret is erased) | API key |
| POST /v1/quantum/verify | Verify an ML-DSA or SLH-DSA signature | API key |