Skip to main content

Guides

Run accessibility scans through the API

Learn how to start accessibility scans from your own software, follow their progress and bring findings into your team’s work.

By Eivind Pihl Martinsen, Synli.aiLast updated November 13, 2026

API workflow
  1. Prepare a target and key
  2. Start a scanKeep the returned scan ID.
  3. Read resultsCheck completion before requesting findings or a report.

Use the Synli API to run accessibility checks from software you already use. For example, your deployment script can start a scan after a website update and collect the findings for your team's review. API access is included in Pro and Enterprise, and scans use your organization's existing allowance.

Start with an approved target

  1. Save and approve the site and scan scope in Synli. API requests refer to a target ID; they cannot scan an arbitrary URL or read site credentials.
  2. Create an API key with the access your integration needs. Keep it secure and revoke it when the integration ends.
  3. List your approved targets, start a scan for the intended site and save the scan ID returned by the API.
  4. Check the scan status before collecting its summary and findings. If the team needs a PDF report, request a report link.

Build a useful handoff

Store the scan ID and the target you intended to test. Present the summary with individual findings and affected pages so a person can reproduce and prioritize each issue. Handle failed or incomplete scans explicitly; a request to start a scan is not a finished audit. If the target changes or is archived, check its current state before retrying.

If you prefer to work from an AI assistant, the local MCP client uses this same target-based API. For regular scans that do not depend on your own integration, a schedule may be simpler.

Sources