Operation convert-pdfa
The convert-pdfa operation allows for the conversion of a PDF file to a PDF/A archive, which is a specialized format designed for long-term preservation of electronic documents.
PDF/A ensures that documents will be rendered correctly and consistently over time, even if the software and hardware used to view the documents change.
Available Options
| Option Name | Type | Possible Values | Description |
|---|---|---|---|
| validation_profile | string | pdfa1a, pdfa1b, pdfa2a, pdfa2b, pdfa2u, pdfa3a, pdfa3b, pdfa3u | The converted file is PDF/A compliant to the specified profile |
| strict_mode | boolean | true, false | If true, it will not modify the appearance of the input file in order to make it PDF/A compliant.
This means that any elements of the file that do not meet the requirements of the selected PDF/A profile will not be altered,
potentially resulting in a non-compliant PDF/A file and a failing conversion. If false, the convert-pdfa operation will make any necessary modifications to the input file in order to make it PDF/A compliant. |
| allow_multiple_outputs | boolean | true, false | If the comparison produces more than one output file, by default all of them are compressed in just one file. Set this option to true if you want a download link for each file. |
Options Details
| Profile | Description |
|---|---|
| pdfa1a | This profile requires that all fonts be embedded and that the document's visual appearance be fully self-contained |
| pdfa1b | This profile is similar to pdfa1a, but allows for certain color spaces to be not embedded |
| pdfa2a | This profile is similar to pdfa1a, but allows for the use of transparent objects and requires that the document be tagged with logical structure information |
| pdfa2b | This profile is similar to pdfa2a, but allows for certain color spaces to be not embedded |
| pdfa2u | This profile is similar to pdfa2a, but allows for Unicode encoding of text strings |
| pdfa3a | This profile is similar to pdfa2a, but allows for the use of JPEG 2000 image compression |
| pdfa3b | This profile is similar to pdfa3a, but allows for certain color spaces to be not embedded |
| pdfa3u | This profile is similar to pdfa3a, but allows for Unicode encoding of text strings |
Example
{
"conversion": [{
"category": "operation",
"target": "convert-pdfa",
"options": {
"validation_profile": "pdfa1b",
"strict_mode": true
}
}]
}