API Overview

The QuantumSafe REST API provides programmatic access to PQC key generation, hybrid signing, verification, and wallet scanning.

Base URL

EnvironmentBase URL
Mainnethttps://api.quantumsafe.io/v1
Testnethttps://api.testnet.quantumsafe.io/v1
All endpoints are prefixed with /v1.

Versioning

The /v1/ path prefix represents the schema version of the API, not the product version. This means:
  • /v1/ endpoints maintain backward-compatible request/response schemas
  • New fields may be added to responses (additive changes) without a version bump
  • Breaking changes (removed fields, changed types) will result in /v2/
  • Product features (e.g., Managed Custody in v1.5) are released within the /v1/ schema
You do not need to update your API version when QuantumSafe releases new product versions. The /v1/ schema is stable.

Authentication

All requests must include your API key in the Authorization header:
Authorization: Bearer qs_sec_live_your_key_here
See Authentication Guide for key types and environments.

Request Format

  • Content type: application/json
  • All request bodies are JSON
  • All hex values should be 0x-prefixed or raw hex strings
curl -X POST https://api.quantumsafe.io/v1/keys/generate \
  -H "Authorization: Bearer qs_sec_live_your_key_here" \
  -H "Content-Type: application/json" \
  -d '{
    "algorithm": "ml-dsa-65",
    "chain": "ethereum",
    "format": "hex"
  }'

Response Format

All responses follow a consistent structure: Success:
{
  "data": {
    "id": "key_abc123",
    "algorithm": "ml-dsa-65",
    "publicKey": "0x..."
  },
  "meta": {
    "requestId": "req_xyz789",
    "timestamp": "2026-01-15T10:30:00Z"
  }
}
Error:
{
  "error": {
    "code": "AUTH_001",
    "message": "API key is missing or malformed",
    "details": {}
  },
  "meta": {
    "requestId": "req_xyz789",
    "timestamp": "2026-01-15T10:30:00Z"
  }
}

Endpoints Summary

MethodEndpointDescriptionKey Type
POST/v1/auth/registerRegister a new accountNone
POST/v1/auth/loginAuthenticate and get tokenNone
POST/v1/auth/api-keysCreate a new API keySecret
GET/v1/auth/api-keysList API keysSecret
DELETE/v1/auth/api-keys/{id}Delete an API keySecret
POST/v1/keys/generateGenerate a PQC key pairSecret
POST/v1/verifyVerify an attestationSecret
POST/v1/sign/hybridCreate hybrid attestationSecret
POST/v1/scan/walletScan wallet for quantum riskPublishable or Secret