Getting Started with adaline.report
Set up your account, get an API key, and run your first compliance scan.
What is adaline.report?
adaline.report is a standalone compliance scoring API that analyzes documents for ADA accessibility issues. It runs 12 automated checks across 6 WCAG categories and returns a detailed report with scores, grades, and specific issues.
You can use it through the web dashboard at adaline.report or integrate it into your own applications via the REST API.
Creating Your Account
- Visit adaline.report and click Sign Up
- Enter your email, password, and full name
- You'll land on an empty dashboard ready for your first scan
Getting an API Key
To use the API programmatically:
- Go to Settings in the sidebar
- Click Create API Key
- Give it a descriptive name (e.g., "CI Pipeline" or "Dev Testing")
- Copy the key immediately -- it won't be shown again
Include the key in all API requests:
curl -X POST https://api.adaline.report/api/v1/scan \
-H "X-API-Key: your-api-key" \
-F "file=@document.pdf"
Your First Scan
Via the Dashboard
- Click New Scan on the dashboard
- Drag and drop a document or click to browse
- Supported formats: PDF, DOCX, PPTX, HTML, Markdown, LaTeX
- The scan runs automatically and results appear in seconds
Via the API
curl -X POST https://api.adaline.report/api/v1/scan \
-H "X-API-Key: your-api-key" \
-F "file=@syllabus.pdf"
The response includes your overall score, grade, and every check result.
Understanding Your Score
- Grade A (95-100%) -- Fully compliant
- Grade B (85-94%) -- Minor issues to fix
- Grade C (70-84%) -- Notable accessibility gaps
- Grade D (50-69%) -- Significant barriers
- Grade F (below 50%) -- Major remediation needed
See Reports and Scoring for a detailed breakdown.
Next Steps
- Scanning Documents -- Supported formats and scan options
- Reports and Scoring -- Understanding your results
- API Reference -- Full endpoint documentation
- Python Examples -- Code examples