AllyProof Documentation
AllyProof combines accessibility scanning, AI fix suggestions, and assessment evidence with a separate privacy and compliance check. Use this documentation to configure your account and understand the results.
Guides
- Quick StartAdd your website, run an accessibility scan and review the findings.
- Scanning EnginesHow axe-core, HTML_CodeSniffer, and APCA work together, and what each layer can and cannot detect.
- CLICross-platform CLI for triggering scans, fetching history, and gating CI/CD.
- CI/CD IntegrationAdd accessibility checks to GitHub Actions, GitLab CI, or Jenkins pipelines.
- API ReferenceComplete REST API documentation for all endpoints.
- NotificationsEmail alerts for scan results, critical violations, and weekly digests.
- VPAT-based AssessmentsCreate a proprietary evidence draft in WCAG, 508, EU, or INT format for a qualified evaluator.
- Selected Accessibility BarriersUnderstand selected rule matches and severity without treating them as a legal-risk prediction.
- How It WorksScan pipeline, data security, integrations, and coverage limitations.
- Team & PermissionsMulti-org support, role-based access, audit logs, and team collaboration.
- Sharing & BadgesShared reports, embeddable badges, scan evidence summaries, and AI fix export.
- WebhooksReceive scan events in your own systems with HMAC-signed payloads.
- Jira CloudPer-site routing to multiple Jira projects, bulk push, optional auto-push; closed tickets auto-resolve in AllyProof.
- Billing & PlansPlan tiers, upgrades and downgrades, cancellation, and invoices.
Key Concepts
Multi-Engine Scanning
AllyProof combines axe-core and HTML_CodeSniffer automated findings with separate APCA contrast observations. Results retain engine attribution, with manual-review items kept separate. Screenshots are included where available.
Accessibility Score
Each site gets a 0–100 score based on open violation counts. Each critical deducts 10 (cap 50), each serious 5 (cap 30), each moderate 2 (cap 15), each minor 0.5 (cap 5). A score of 100 means no automated violations were found — still not a conformance claim, because the scanner has only ruled out the failure patterns its rules cover. See Scoring for the worked formula.
Remediation Workflow
Each violation can be assigned to a team member, tracked through a workflow (open → in progress → resolved), and verified automatically on subsequent scans. Violations can also be moved sideways to suppressed (with a reason code — false positive, accepted risk, third-party, will fix later, not applicable) or accepted exception. Bulk actions apply the same change to many rows at once, always with a short reason for the audit trail. Threaded comments allow team discussion on each issue.
VPAT Generation
AllyProof creates proprietary evidence drafts in WCAG, 508, EU, and INT editions. WCAG and INT include the 55 active WCAG 2.2 A/AA criteria; the other editions use their applicable standards. Automated evidence is separate from official conformance levels, which remain blank for a qualified evaluator. The export is not the official ITI form, a completed ACR, or certification.
Selected Accessibility Barriers
This card highlights open findings for seven selected axe-core rules. Its status reflects matching findings and severity, not lawsuit probability. Review other findings and manual checks alongside it.
AI Fix Suggestions
On eligible paid plans, saved AI suggestions appear immediately on an issue page. An authorized member opening a missing suggestion requests it for that issue only. Manual-review findings are excluded. Review and test proposed changes before applying them. Use Copy for AI agent to copy the issue context for your development tools.
Ongoing Monitoring Signals
Issues that reappear after being resolved fire a dedicated violation.regressed webhook and a regression digest email — distinct from the standard new/resolved events so “we fixed it, why is it back?” is visible immediately. The Accessibility Seal and verify card both surface the active scan cadence (checked daily / weekly), so visitors can tell ongoing monitoring apart from a one-off snapshot.
Multi-site dashboard
With one website, the dashboard shows its findings, scan history and review actions. Open My website for details. With multiple websites, use Sites to select a website and compare results.