Documentation

Get from zero to a posture score in under ten minutes.

• 1. Create an account — Sign up with email or connect GitHub, GitLab, or Bitbucket.
• 2. Connect sources — Select repositories and add cloud or identity providers from Integrations.
• 3. Enable frameworks — Turn on SOC 2, HIPAA, ISO 27001, or any combination supported in your plan.
• 4. Review gaps — Use the dashboard for severity-ranked findings with remediation steps.
• 5. Export evidence — Publish policies and download evidence when frameworks are audit-ready.

Shieldoq reads configuration and security signals from your whole stack—not only application repositories.

Trigger scans from the Scans page or rely on scheduled runs. Permission requirements are listed per provider in the in-app Integrations catalog.

• SOC 2 / SOC 1 / SOC 3 — Trust services criteria
• HIPAA — Safeguards for protected health information
• ISO 27001 & ISO 42001 — Security management and AI governance
• GDPR — Privacy-oriented control coverage
• PCI DSS, FedRAMP, CMMC — Growth and Enterprise tiers

Gaps link to control requirements with severity, source, affected resources, and remediation guidance. Resolve gaps when fixes ship; evidence flows to the vault.

The Controls library shows per-framework implementation status—filter by owner or status for auditor working sessions.

Copilot answers questions in context of your gaps and integrations—e.g. why a control failed and what change fixes it.

Policy generator outputs Markdown from your environment. Review, edit, and publish before external distribution.

REST API base URL (development default): http://localhost:3001. Use an API key from Settings → API Keys.

• GET /api/v1/dashboard — Posture and gap summary
• GET /api/v1/gaps — List compliance gaps
• GET /api/v1/controls — Control catalog
• GET /api/v1/integrations — Provider status
• POST /api/v1/scans — Trigger a scan

Send header X-Org-Slug on every request. Contact support@shieldoq.com for OpenAPI access.