Checking and tagging PDFs through an API
Nobody checks hundreds of generated PDFs a day by hand. The EasyPDFUA API plugs PDF/UA checks and baseline tagging straight into the processes you already run.
Last updated:
Where a checking interface fits
Accessibility rarely fails for lack of knowledge. It fails on volume. Invoices, official notices, reports and forms are produced automatically, often by systems that cannot create tagged PDFs at all. A check-and-tag interface lets you inspect every document inside the process, before it reaches customers or citizens.
A document management system can check new files on import and store the findings as metadata. In invoice and notice dispatch, generated PDFs can be checked and given baseline tags before they go out. In a CMS, editors learn on upload whether the title, language or tags are missing. And during a migration, a batch run over the archive helps decide which files to rework first.
Three endpoints
Every call needs a personal bearer token in the Authorization header.
POST /api/v1/inspect/checks a PDF sent as the multipart fieldpdf. The document is not modified.POST /api/v1/tag/creates a retroactively tagged copy. Along withpdfyou sendtitleandlanguage(a BCP 47 code such asen-GB).GET /api/v1/download/?token=…collects the tagging result, using the same bearer header.
Example: check a PDF
curl -X POST https://easypdfua.com/api/v1/inspect/ \
-H "Authorization: Bearer $EASYPDFUA_TOKEN" \
-F "pdf=@report.pdf"
The JSON response has three parts. status holds success, operation, API version and timestamp, result the assessment with pdfUaOk, verdict and warningCount. details contains the full report with structure tree and warnings.
Tagging and downloading
curl -X POST https://easypdfua.com/api/v1/tag/ \
-H "Authorization: Bearer $EASYPDFUA_TOKEN" \
-F "pdf=@report.pdf" \
-F "title=Annual Report 2026" \
-F "language=en-GB"
# Response (shortened)
{
"status": { "success": true, "operation": "tag", ... },
"result": {
"verdict": "issues_found",
"outcome": "tagged",
"output": {
"downloadUrl": "https://easypdfua.com/api/v1/download/?token=…",
"sha256": "…",
"expiresInSeconds": 900,
"singleUse": true
}
},
"details": { ... }
}
curl -H "Authorization: Bearer $EASYPDFUA_TOKEN" \
-o report-tagged.pdf "<downloadUrl>"
The download URL is valid for 15 minutes and works exactly once. A PDF that is already tagged is only analysed (outcome: already-tagged-analyzed), and no new file is created. The SHA-256 hash in the response tells you whether the download arrived intact.
Security and privacy
You see the token in full only once, and only its SHA-256 hash is stored. PDF contents are not sent to any external service and do not end up in logs. The same conservative rules apply as in the browser: encrypted, signed or technically ambiguous PDFs are rejected rather than changed at risk.
Errors come back as JSON with error.code and a matching HTTP status, for example 401 for an invalid token or 413 when the file exceeds the limit.
What tagging covers
Tagging is deliberately conservative. Each page gets a generic P tag with marked content. Title, document language and the pdfuaid:part = 1 identifier go into the XMP metadata, and DisplayDocTitle is set. Standalone web and email addresses become real links with a Link tag, and the pages concerned get /Tabs /S. The API repairs missing ToUnicode mappings where this is unambiguous. A missing TrueType font program is embedded only if a local font file with the same PostScript name exists, its licence bits permit embedding and its widths match exactly.
The API does not create headings, tables, lists or alternative text. Those need an understanding of the content and usually manual work, see Tag an existing PDF.
Automated quality assurance should run veraPDF as well. The open-source validator fits well into CI pipelines and batch jobs. Its typical messages are explained in Common PAC and veraPDF errors.
Access
The API is part of the Premium plan: files up to 50 MB, unlimited operations and a personal token that you create under “API access” in the application. See Premium.
Frequently asked questions
Who can use the API?
Premium accounts only. Free accounts can see the API section but cannot create a token there.
How large can PDFs be?
Up to 50 MB per file, with no daily limit on operations.
How long is the tagged PDF available?
For 15 minutes, and only once. The file is deleted afterwards.
Is the API result a PDF/UA certification?
No. The assessment is based on EasyPDFUA’s internal checks and is not a normative PDF/UA validation. We recommend cross-checking with veraPDF or PAC and a manual review.