Make existing PDF's accessible
Introduction
This service provides two main endpoints: make-pdf-accessible and validate-pdf. The purpose of this service is to help users make their existing PDF documents accessible and validate the accessibility of their PDFs.
The service can be tested at allegradocs.pathfindr.dev, and there is an on-premise version available if needed. To test the solution, please reach out to sales to get an api_key.
To get the best result a configuration for each document type should be created. If no document_id is provided, the service will use the default configuration, which is a good starting point for most documents. This service requires a separate API key and license.
Endpoints
make-pdf-accessible
This endpoint takes an existing PDF and makes it accessible.
| Parameter | Type | Description |
|---|---|---|
pdf_file | file | The PDF file to be made accessible |
document_id | string | If a configuration for document_id has been created, this will be used to process the document |
Example Request
curl --location 'https://allegradocs.pathfindr.dev/make-pdf-accessible' \
--header 'Authorization: ••••••' \
--form 'template_id="23"' \
--form 'file=@"PATH_TO_YOUR_FILE.pdf"'
validate-pdf
This endpoint takes an existing PDF and validates its accessibility.
| Parameter | Type | Description |
|---|---|---|
pdf_file | file | The PDF file to be made accessible |
validation_profile | string | The standard to validate against - the value can be: ua1, ua2, wcag |
Example Request
curl --location 'https://allegradocs.pathfindr.dev/validate-pdf' \
--header 'Authorization: ••••••' \
--form 'file=@"/PATH_TO_YOUR_FILE.pdf"' \
--form 'validation_profile="ua1"'