Documentation

Everything you need to scan, monitor, and prove WCAG/ADA compliance.

Quickstart

Sign up, add your first site, and trigger a scan in under a minute.

API Reference

REST endpoints for sites, scans, and reports. Auth via Bearer token or API key.

CI/CD Integration

Trigger a scan on every deploy and fail the build above your score threshold.

WCAG & ADA Primer

Short, actionable guides on what gets scanned and why each issue matters.

Quickstart

  1. Sign up at access-proof.com/register. Free plan gives you 1 site and 1 scan per month.
  2. Add a site from the dashboard. Paste the URL you want to monitor.
  3. Run a scan. Results land in 30–90 seconds depending on the page size.
  4. Read the report. Issues are grouped by impact (critical → minor) and mapped to WCAG 2.2 success criteria.
  5. Download the PDF for stakeholders, clients, or compliance archives.

CI/CD integration (Pro & Business)

Generate an API key from Settings → API keys, then trigger a scan on every deploy:

# .gitlab-ci.yml or GitHub Actions
- curl -X POST https://api.access-proof.com/scans \
    -H "Authorization: Bearer $ACCESSPROOF_API_KEY" \
    -H "Content-Type: application/json" \
    -d '{"site_id": "your-site-id"}'

Poll GET /scans/<id> until status is completed, then fail the build if the score is below your threshold:

SCORE=$(curl -s -H "Authorization: Bearer $ACCESSPROOF_API_KEY" \
  https://api.access-proof.com/scans/$SCAN_ID | jq .score)
if (( $(echo "$SCORE < 90" | bc -l) )); then
  echo "WCAG score $SCORE below threshold 90"
  exit 1
fi

See the full API Reference for all endpoints.

Need help?

Email [email protected]. Replies within one business day.