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

EndpointPurposeAccess
GET /healthLivenessPublic
GET /health/readyReadiness: database and Redis reachablePublic
GET /metricsPrometheus metricsPublic
GET /openapi.jsonOpenAPI 3.1 document for this APIPublic

Identity

EndpointPurposeAccess
POST /v1/admin/identities/{did}/{action}Operator lifecycle action (activate, suspend, reinstate)Administrator
POST /v1/identitiesCreate a did:quantlayer identity (self-certifying, proof of possession)API keyidentity:write
GET /v1/identities/{did}Resolve an identity (public projection)API keyidentity:read
POST /v1/identities/{did}/accountsLink a wallet account (EIP-712 ownership proof)API keyidentity:write
POST /v1/identities/{did}/accounts/unlinkUnlink a wallet accountAPI keyidentity:write
POST /v1/identities/{did}/deactivateDeactivate an identity (terminal)API keyidentity:write
POST /v1/identities/{did}/keysRegister a new verification methodAPI keyidentity:write
POST /v1/identities/{did}/keys/revokeRevoke a key versionAPI keyidentity:write
POST /v1/identities/{did}/keys/rotateRotate a verification method (the algorithm may change, e.g. Ed25519 → ML-DSA-65)API keyidentity:write
POST /v1/identities/challengesIssue a single-use challenge for an identity operationAPI keyidentity:write

Developer

EndpointPurposeAccess
POST /v1/admin/projects/{projectId}/planAssign a project's subscription plan (administrator)Administrator
POST /v1/admin/projects/{projectId}/statusSuspend or reactivate a project (administrator)Administrator
DELETE /v1/auth/sessionSign out (revoke the current session)Wallet session
GET /v1/auth/sessionCurrent wallet sessionWallet session
POST /v1/auth/wallet/challengeStart wallet sign-in (EIP-712)Public
POST /v1/auth/wallet/verifyFinish wallet sign-in and create a sessionPublic
GET /v1/developer/projectsList the signed-in wallet's projectsWallet session
POST /v1/developer/projectsCreate a project owned by the signed-in walletWallet session
GET /v1/developer/projects/{projectId}/api-keysList a project's API keys (no secrets)Wallet session
POST /v1/developer/projects/{projectId}/api-keysCreate an API key (the secret is returned once)Wallet session
DELETE /v1/developer/projects/{projectId}/api-keys/{keyId}Revoke an API keyWallet session
GET /v1/developer/projects/{projectId}/audit-eventsA project's audit trail (newest first)Wallet session
GET /v1/developer/projects/{projectId}/usageA project's metered usage: plan, quota for the current period and daily countsWallet session
GET /v1/developer/whoamiDescribe the calling API keyAPI key

Authorization

EndpointPurposeAccess
GET /v1/authorization/capabilitiesAuthorization modes and signature algorithms this server acceptsPublic
POST /v1/authorization/decisionsDecide an authorization requestAPI keyauthorization:decide
POST /v1/authorization/policiesPublish a verification policy version (immutable)API keyauthorization:policies
POST /v1/authorization/policies/{policyId}/minimum-versionRetire older policy versionsAPI keyauthorization:policies
POST /v1/authorization/revocationsEmergency revocation of a key version (`keyId@version`) or a request idAPI keyauthorization:policies

Blockchain

EndpointPurposeAccess
GET /v1/blockchain/credential-status/{issuerId}/{credentialIdHash}Indexed on-chain credential status (QuantLayerCredentialRegistry)API keyblockchain:read
GET /v1/blockchain/networkChain, head, configured QuantLayer contracts and indexer progressAPI keyblockchain:read
POST /v1/blockchain/transactionsTrack a submitted transactionAPI keyblockchain:write
GET /v1/blockchain/transactions/{id}Tracked transaction statusAPI keyblockchain:read

Credentials

EndpointPurposeAccess
POST /v1/credentials/external/verifyVerify an external credential or Verifiable PresentationAPI keycredentials:verify
POST /v1/credentials/issuersRegister an issuer (did:quantlayer identity with a post-quantum custody key)API keycredentials:issue
GET /v1/credentials/issuers/{issuerId}Get an issuerAPI keycredentials:read
POST /v1/credentials/issuers/{issuerId}/credentialsIssue a selectively disclosable credential (quantlayer.credential/2)API keycredentials:issue
GET /v1/credentials/issuers/{issuerId}/credentials/{credentialId}Issued-credential record and its status history (no claim values)API keycredentials:read
POST /v1/credentials/issuers/{issuerId}/credentials/{credentialId}/{action}Revoke, suspend or reinstate a credential (republishes the signed status list)API keycredentials:issue
POST /v1/credentials/presentations/verifyVerify a holder presentationAPI keycredentials:verify
GET /v1/credentials/status-lists/{listId}Latest signed status list snapshot (public)Public

Privacy

EndpointPurposeAccess
GET /v1/privacy/nullifiers/{scope}/{nullifier}Whether a nullifier has been spent in a scopeAPI keyprivacy:read
POST /v1/privacy/treesCreate a commitment tree (Poseidon-BN254, depth 20)API keyprivacy:write
GET /v1/privacy/trees/{treeId}Tree metadata and current rootAPI keyprivacy:read
POST /v1/privacy/trees/{treeId}/leavesAppend a commitment leafAPI keyprivacy:write
POST /v1/privacy/trees/{treeId}/leaves/{index}/removeRevoke a leaf (zeroed; the slot is never reused)API keyprivacy:write
GET /v1/privacy/trees/{treeId}/proofs/{index}Merkle membership path for a leafAPI keyprivacy:read
POST /v1/privacy/trees/{treeId}/publishPublish the current root to the root registryAPI keyprivacy:write

Proofs

EndpointPurposeAccess
GET /v1/proofs/capabilitiesProof systems this server supports (versions from the committed circuit manifest)Public
GET /v1/proofs/jobs/{jobId}Proof job status and resultAPI keyproofs:read
POST /v1/proofs/jobs/proveQueue delegated proving (the witness is sealed before it is queued)API keyproofs:write
POST /v1/proofs/jobs/verifyQueue verification of a proof against a requestAPI keyproofs:write
POST /v1/proofs/requestsCreate a proof request (verifier side)API keyproofs:write

Quantum

EndpointPurposeAccess
POST /v1/quantum/keysGenerate a post-quantum key in custodyAPI keyquantum:keys
GET /v1/quantum/keys/{name}Public key ring (all versions)API keyquantum:keys
POST /v1/quantum/keys/{name}/rotateRotate, or migrate to another algorithm of the same kindAPI keyquantum:keys
POST /v1/quantum/keys/{name}/signSign with the active versionAPI keyquantum:sign
POST /v1/quantum/keys/{name}/versions/{version}/decapsulateML-KEM decapsulation with a custody keyAPI keyquantum:keys
POST /v1/quantum/keys/{name}/versions/{version}/revokeRevoke a key version (terminal; its sealed secret is erased)API keyquantum:keys
POST /v1/quantum/verifyVerify an ML-DSA or SLH-DSA signatureAPI keyquantum:verify