Convert to PDF/A

POST https://api.pdfrest.com/pdfa

Convert a PDF into an archival format.

Required form-data body parameters:

  • One of:
    • file - File to be uploaded and processed
    • id - Alphanumeric ID (UUID) of existing file on server to be processed
  • output_type - Set to one of the following PDF/A versions:
    • PDF/A-1b - Basic conformance with visual appearance.
    • PDF/A-2b - Basic conformance with archival standards but revised for later versions of the PDF format. PDF/A-2 includes options for OpenType fonts, layers, attachments (which must also be PDF/A compliant) and JPEG 2000 image compression.
    • PDF/A-2u - Matches PDF/A-2b but also requires that all text in the document have Unicode mappings.
    • PDF/A-3b - Matches PDF/A-2b, except that it is possible to embed any kind of file in the PDF document. For example, with PDF/A-3 a user can save a XML, CSV, CAD, spreadsheet, or other type of file in the PDF document and be compliant. The file embedded in the PDF/A-3 does not need to be PDF/A compliant.
    • PDF/A-3u - Matches PDF/A-3b, but also requires that all text in the document have Unicode mapping.

Optional form-data body parameters (bold = default:

  • output - File name of output file (no extension)

  • rasterize_if_errors_encountered - When set to on, if the API finds errors when converting a PDF document, it will rasterize the page with the problem into a graphic image and continue to save the document as a PDF/A document. If set to off, it will instead return an error in such cases.

Request Body

[{"name"=>"file", "value"=>nil, "datatype"=>"null"}, {"name"=>"id", "value"=>"xxxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx", "datatype"=>"string"}, {"name"=>"output", "value"=>"pdfrest_pdfa", "datatype"=>"string"}, {"name"=>"output_type", "value"=>"PDF/A-2b", "datatype"=>"string"}, {"name"=>"rasterize_if_errors_encountered", "value"=>"off", "datatype"=>"string"}]

HEADERS

KeyDatatypeRequiredDescription
Api-Keystring