Developer portal
Assess workflow
Assess combines active discovery with reproducible reporting: scan, poll, export, and independently verify.
Last updated: 2026-06-09
Workflow overview
- Start a scan with
POST /pqc/scan. - Check progress via
GET /pqc/scan/{scan_id}. - Export evidence with
GET /pqc/report/{scan_id}. - Validate signatures through
GET /pqc/verify/{scan_id}orPOST /pqc/verify.
1) Start the scan
Use fixture mode for deterministic demos and live mode for external target inventory. For async scans, persist complete output to tenant history with POST /pqc/scan/{scan_id}/persist so downstream workflows can consume a stable result set.
2) Poll until complete
Polling should treat status transitions as stateful events, not just progress percentages. Once status reaches complete, query GET /pqc/report/{scan_id}/availability to pick the final output format (json, csv, cbom, pdf).
3) Produce report artifacts
- JSON for machine workflows:
GET /pqc/report/{scan_id} - CBOM evidence:
GET /pqc/report/{scan_id}?format=cbom - Human-readable audit packet:
GET /pqc/report/{scan_id}?format=pdf
Interactive UI at /assess
The product page at /assess starts with three paths: sample report (no domain), Open Quantum Safe live demo, or authorized workspace for your domain. Customize to run a three-step wizard (scenario → scope → run), then open a tabbed readout: Executive, Compliance, Inventory, Remediation, Technical, and Evidence.
- Auto-run demos:
/assess?scenario=bank-tls-inventory&autorun=1 - Revisit a completed scan:
/assess?scanId=… - Lead funnel: /assess/mini → full assess with autorun
Board readout (15 minutes)
- Executive tab — readiness score, peer band, top vulnerability, Mosca timeline.
- Compliance tab — framework mapping and migration roadmap.
- Evidence tab — PDF + verify link for auditors.
- Upsell — drift preview and Monitor proposal (fixture or live diff).
4) Verify and share confidence
Verification checks report content hash, signer identity, and optional transparency inclusion. Continue with the Verify tool and the Verify specification for offline controls in CI and customer assurance workflows.
Found an issue? Report documentation feedback