Create PDF/A
Convert → Create PDF/A
The Create PDF/A API converts a regular PDF to PDF/A (ISO archival format). You send the PDF as Base64 (docContent), docName, compliance (e.g. PdfA1b, PdfA2b, PdfA3u), allowUpgrade, allowDowngrade, and IsAsync. The API returns the PDF/A document (or 202 + Location for async). Use the tester below to try it; more details are in the sections that follow.
Try the Create PDF/A API
Endpoint: POST /api/v2/PdfA · Required: api-key, docContent, docName, compliance, allowUpgrade, allowDowngrade, IsAsync
Use the form below to send your API key and PDF (Base64). Set compliance level and upgrade/downgrade options; the response is the PDF/A document (or polling URL when async). No code required—fill the fields and click Send request.
Overview, parameters, and use cases
- Overview
- Parameters
- Use cases
What is Create PDF/A?
This endpoint converts a regular PDF to PDF/A (ISO standard for long-term archival). You provide the PDF (Base64), docName, compliance (PdfA1a, PdfA1b, PdfA2a, PdfA2b, PdfA2u, PdfA3a, PdfA3b, PdfA3u), allowUpgrade, allowDowngrade, and IsAsync. The API returns the PDF/A document or a Location URL for async.
Key features
- Compliance – PdfA1a/1b, PdfA2a/2b/2u, PdfA3a/3b/3u.
- Upgrade/downgrade – allowUpgrade and allowDowngrade for compliance flexibility.
- Async – IsAsync returns 202 with Location URL for polling.
Use when you need archival PDFs (compliance, long-term preservation). For general conversion use Convert to PDF; for web-optimized PDFs use Linearize PDF.
API parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| api-key | string | Yes | Your PDF4me API key, Base64 encoded. Get it from the dashboard. |
| docContent | base64 | Yes | PDF file content (Base64). |
| docName | string | Yes | Output file name (e.g. output). |
| compliance | string | Yes | PDF/A level: PdfA1a, PdfA1b, PdfA2a, PdfA2b, PdfA2u, PdfA3a, PdfA3b, PdfA3u. |
| allowUpgrade | boolean | Yes | Allow upgrading to higher compliance. |
| allowDowngrade | boolean | Yes | Allow downgrading to lower compliance. |
| IsAsync | boolean | Yes | Enable asynchronous processing. |
When to use Create PDF/A
- Archival – Convert PDFs to PDF/A for long-term preservation.
- Compliance – Meet ISO PDF/A requirements for regulated documents.
- Pipelines – Use after conversion or editing before archival storage.
For request/response schemas and code samples, see Create PDF/A in the PDF4me API docs.
Prerequisites
Before using this endpoint, make sure you have:
- A valid PDF4me API key (Get your API Key)
- A PDF document in Base64 format
Response Format
The API returns a PDF/A compliant document:
- Status 200: PDF/A conversion completed immediately - binary PDF/A content in response body
- Status 202: Request accepted and processing asynchronously - use the Location header URL to poll for results
For asynchronous requests, poll the Location URL until status 200 is returned with the PDF/A document.