Check a PDF's accessibility against PDF/UA
check_pdf_accessibilityCheck whether a PDF is accessible by PDF/UA, the ISO standard for accessible PDF.
veraPDF checks the machine-checkable rules of PDF/UA: tags, structure, alt text present, fonts, metadata. Whether alt text or reading order make sense still needs a person.
Input: pdf_base64 is the PDF as base64, at most 4 MB decoded; or pass the
file as a download link in file. profile is "ua1" or "ua2".
Returns compliant (true or false), profile_name, statement,
passed_rules, failed_rules and top_failed_rules: up to 10 failed rules
with their id (clause and test number), specification, description and
failed_checks. A file that is not a PDF fails with not_a_pdf; an
unavailable veraPDF with engine_unavailable. For the full report, use the
REST API (POST /v1/verapdf/api/validate/ua1).
Credits: 10 per call.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| file | No | The file as a download link, instead of `pdf_base64`. In ChatGPT, pass the user's uploaded file here. Other clients can set `download_url` to a public https URL. | |
| profile | No | "ua1" (the default) checks against PDF/UA-1 (ISO 14289-1), "ua2" against PDF/UA-2 (ISO 14289-2). | ua1 |
| pdf_base64 | No | The PDF, base64-encoded. At most 4 MB decoded. |
Output Schema
| Name | Required | Description | Default |
|---|---|---|---|
No arguments | |||