Q-CORE API Documentation

Post-quantum cybersecurity assessment platform. 220+ modules, 247 algorithms, 22 standards. CRA + DORA + NIS2 compliance.

https://qcore.systems/api/

Authentication

All API requests require an API key sent via the X-API-Key header. Some public endpoints (health, scan, mapping) are available without authentication from the web interface.

To get an API key, contact info@qcore.systems or request one through the platform.

Tier Limits

Tier	Daily Requests	PDF Reports	Modules	Price
Starter	100/day	CRA	13	Contact us
Business	1,000/day	CRA + DORA + NIS2	56	Contact us
Enterprise	10,000/day	All frameworks	82	Contact us
Sovereign	Unlimited	All + custom	220+	Contact us

Core Endpoints

▶ GET /api/health System health check PUBLIC

Returns system status and timestamp. No authentication required.

Example

curl https://qcore.systems/api/health

Response

{"status": "ok", "timestamp": "2026-03-18T12:00:00+00:00"}

▶ POST /api/scan PQC vulnerability scan PUBLIC

Scan a domain for post-quantum cryptography vulnerabilities. Analyzes TLS, certificates, ciphers, HTTP headers, and quantum risk exposure.

Request Body

Field	Type	Description
domain	string	Domain to scan (e.g. "example.com") required

Example

curl -X POST https://qcore.systems/api/scan \ -H "Content-Type: application/json" \ -d '{"domain": "example.com"}'

Response

{ "hostname": "example.com", "tls_version": "TLSv1.3", "overall_risk_score": 35, "overall_pqc_status": "not quantum-safe", "quantum_risks": [...], "cipher": {...}, "certificate": {...}, "http_headers": {...}, "recommendations": [...] }

▶ GET /api/usage Check your API key usage API KEY

Check your API key usage, remaining daily requests, tier info.

Headers

Header	Description
X-API-Key	Your API key required

Example

curl https://qcore.systems/api/usage \ -H "X-API-Key: qcore_bz_your_key_here"

Response

{ "status": "ok", "tier": "BUSINESS", "daily_limit": 1000, "requests_today": 42, "requests_remaining": 958, "requests_total": 1337 }

▶ GET /api/modules List all platform modules PUBLIC

Returns all Q-CORE platform modules with their status and tier.

Example

curl https://qcore.systems/api/modules

Compliance Reports (PDF)

▶ POST /api/cra-report EU Cyber Resilience Act PDF report BUSINESS+

Generate a CRA (EU 2024/2847) compliance PDF report from scan data. Supports EN, CS, DE.

Headers

Header	Description
X-API-Key	Business tier or higher required
X-Report-Lang	"en", "cs", or "de" optional, auto-detected from TLD
Content-Type	application/json required

Request Body

Pass the full scan result JSON from /api/scan.

Example

# 1. Scan a domain SCAN=$(curl -s -X POST https://qcore.systems/api/scan \ -H "Content-Type: application/json" \ -H "X-API-Key: YOUR_KEY" \ -d '{"domain":"example.com"}') # 2. Generate CRA report (Czech) curl -X POST https://qcore.systems/api/cra-report \ -H "Content-Type: application/json" \ -H "X-API-Key: YOUR_KEY" \ -H "X-Report-Lang: cs" \ -d "$SCAN" -o CRA_Report.pdf

Response

Returns PDF file (application/pdf).

▶ POST /api/cra-map CRA compliance mapping (JSON) API KEY

Returns CRA article-by-article compliance mapping as JSON. Pass scan data as request body.

Example

curl -X POST https://qcore.systems/api/cra-map \ -H "Content-Type: application/json" \ -H "X-API-Key: YOUR_KEY" \ -d '{"hostname":"example.com","tls_version":"TLSv1.3",...}'

▶ POST /api/dora-report EU DORA compliance PDF report BUSINESS+

Generate a DORA (EU Regulation 2022/2554) compliance PDF report. For banks, insurance, financial institutions. Supports EN, CS, DE.

Headers

Header	Description
X-API-Key	Business tier or higher required
X-Report-Lang	"en", "cs", or "de" optional
Content-Type	application/json required

Example

curl -X POST https://qcore.systems/api/dora-report \ -H "Content-Type: application/json" \ -H "X-API-Key: YOUR_KEY" \ -H "X-Report-Lang: de" \ -d "$SCAN" -o DORA_Report.pdf

▶ POST /api/dora-map DORA compliance mapping (JSON) API KEY

Returns DORA article-by-article compliance mapping as JSON (20 checks across Art.5-45).

▶ POST /api/nis2-report EU NIS2 compliance PDF report BUSINESS+

Generate a NIS2 (EU Directive 2022/2555) compliance PDF report. For critical infrastructure, energy, healthcare, transport. Supports EN, CS, DE.

Headers

Header	Description
X-API-Key	Business tier or higher required
X-Report-Lang	"en", "cs", or "de" optional
Content-Type	application/json required

Example

curl -X POST https://qcore.systems/api/nis2-report \ -H "Content-Type: application/json" \ -H "X-API-Key: YOUR_KEY" \ -H "X-Report-Lang: cs" \ -d "$SCAN" -o NIS2_Report.pdf

▶ POST /api/nis2-map NIS2 compliance mapping (JSON) API KEY

Returns NIS2 article-by-article compliance mapping as JSON (21 checks across Art.20-23).

Module Endpoints (Preview)

Each module provides preview endpoints. Full access requires a Q-CORE license of the appropriate tier.

▶ POST /api/shield/keygen ML-KEM-768 key generation STARTER

Generate ML-KEM-768 (Kyber-768) post-quantum key pair. NIST FIPS 203.

▶ POST /api/shield/encapsulate ML-KEM-768 encapsulation STARTER

Full ML-KEM-768 key encapsulation + decapsulation cycle with verification.

▶ POST /api/tunnel/handshake Hybrid X25519 + ML-KEM-768 tunnel STARTER

Hybrid post-quantum tunnel: X25519 ECDH + ML-KEM-768 with AES-256-GCM encryption.

▶ POST /api/vault/encrypt AES-256-GCM encryption STARTER

Encrypt/decrypt with AES-256-GCM + HKDF key derivation. Preview: max 256 bytes.

▶ POST /api/zkp/attest Zero-knowledge compliance attestation ENTERPRISE

Anonymous compliance attestation using Pedersen Commitments (SHA-384) + ECDSA-P384.

▶ GET /api/module/{name}/status Generic module status PUBLIC

Check status of any Q-CORE module. Replace {name} with module name (e.g. "shield", "vault", "forensics").

Example

curl https://qcore.systems/api/module/forensics/status

Error Codes

Code	Meaning	Solution
400	Invalid request	Check request body and parameters
401	Missing or invalid API key	Set X-API-Key header with valid key
403	Insufficient tier / CSRF blocked	Upgrade tier or check Origin header
415	Wrong Content-Type	Use Content-Type: application/json
429	Rate limit exceeded	Wait or upgrade tier for higher limits
500	Server error	Contact info@qcore.systems
503	Module unavailable	Module may require license or hardware

Get Started

Phone: +420 722 705 318

Q-CORE Systems s.r.o. | Post-Quantum Cybersecurity Platform