> For the complete documentation index, see [llms.txt](https://developerdocs.instructure.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://developerdocs.instructure.com/services/canvas/resources/accessibility_course_scans.md).

# Accessibility Course Scans

## [Get latest accessibility course scan](#method.accessibility_course_scans.show) <a href="#method.accessibility_course_scans.show" id="method.accessibility_course_scans.show"></a>

[AccessibilityCourseScansController#show](https://github.com/instructure/canvas-lms/blob/master/app/controllers/accessibility_course_scans_controller.rb)

#### `GET /api/v1/users/:user_id/educator_accessibility_course_scan`

**Scope:** `url:GET|/api/v1/users/:user_id/educator_accessibility_course_scan`

Returns the most recent bulk accessibility scan Progress for this user, whether it's still in progress or already finished -- null if the user has never triggered a scan. Unlike the trigger endpoint, this never starts a scan; it's safe to call just to check status (e.g. on page load, to resume showing an in-progress scan or to know when the last one finished).

Requires the educator\_dashboard feature flag on the root account and a11y\_checker\_account\_statistics on site admin.

#### Request Parameters:

| Parameter | Type              | Description                                                                                                            |
| --------- | ----------------- | ---------------------------------------------------------------------------------------------------------------------- |
| `user_id` | Required `string` | <p>The ID of the user, or "self" for the current user.<br>The requesting user may only view their own scan status.</p> |

Returns a [Progress](/services/canvas/resources/progress.md#progress) object.

## [Trigger accessibility course scan](#method.accessibility_course_scans.create) <a href="#method.accessibility_course_scans.create" id="method.accessibility_course_scans.create"></a>

[AccessibilityCourseScansController#create](https://github.com/instructure/canvas-lms/blob/master/app/controllers/accessibility_course_scans_controller.rb)

#### `POST /api/v1/users/:user_id/educator_accessibility_course_scan`

**Scope:** `url:POST|/api/v1/users/:user_id/educator_accessibility_course_scan`

Queues a background job that scans all a11y-enabled courses where the user has an active teacher or designer enrollment. Idempotent — if a scan is already queued or running, the existing Progress is returned.

Requires the educator\_dashboard feature flag on the root account and a11y\_checker\_account\_statistics on site admin.

#### Request Parameters:

| Parameter | Type              | Description                                                                                                               |
| --------- | ----------------- | ------------------------------------------------------------------------------------------------------------------------- |
| `user_id` | Required `string` | <p>The ID of the user, or "self" for the current user.<br>The requesting user may only trigger a scan for themselves.</p> |

Returns a [Progress](/services/canvas/resources/progress.md#progress) object.


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://developerdocs.instructure.com/services/canvas/resources/accessibility_course_scans.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.