Public scan badge

Show visitors your site has been audited. Run a scan, copy one line of markdown into your README, and a live SVG badge with the current grade renders inline — clicking it opens the public scan report.

Markdown

Replace SCAN_ID with the ID of any completed scan you own. You can find it in the URL on the results page.

[![Security](https://protectyourvibes.ai/api/badge/SCAN_ID)](https://protectyourvibes.ai/scan/SCAN_ID)

HTML

For sites that don't use markdown.

<a href="https://protectyourvibes.ai/scan/SCAN_ID">
  <img src="https://protectyourvibes.ai/api/badge/SCAN_ID" alt="Security" />
</a>

Caching

The badge endpoint returns an SVG with a CDN cache header. Every time a visitor loads your README, the badge is served from edge cache — no database hit, no scan re-runs.

The badge image refreshes when you trigger a new scan on the same scan ID (Pro / Team) or when the cache TTL expires (currently 5 minutes). If you want an always-current badge, use the latest-scan-for-domain endpoint described in the API docs.

What the badge shows

Letter grade (A–F) plus a colour swatch. A green "A" means zero critical or high findings on the most recent scan. The badge link goes to the full public report — anyone can click through to see exactly what was checked.

If you don't want the report public, scope your scans to a verified domain and use a private dashboard URL instead.

Run a scan to get a badge →Other integrations →