ConvertApi Logo

DOC to PDFA API

The API for converting Word DOC documents to PDF/A files.

API Request:
Copy parameter's URL Secret Secret
Optional

String Authentication secret must be provided as a query parameter. If omitted, token must be provided.

Show all
Copy parameter's URL Token Token
Optional

String Authentication token must be provided as a query parameter. If omitted, secret must be provided.

Show all
Copy parameter's URL File File
Required

File File to be converted. Value can be URL or file content.

Show all
Copy parameter's URL StoreFile Store file
Optional

Bool Store converted file on our secure server and provides download URL.

Default: False

Show all
Copy parameter's URL FileName File name
Optional

String Converted output file name without extension. The extension will be added automatically.

Show all
Copy parameter's URL Timeout Timeout
Optional

Integer Conversion timeout in seconds.

Default: 900

Range: 10 .. 1200

Show all
Copy parameter's URL Async Asynchronous
Optional

Bool Run conversion job asynchronously.

Default: False

Show all
Copy parameter's URL JobId Job ID
Optional

String Conversion job self generated UUID (RFC 4122) used for getting conversion result asynchronously. Also automatically added to WebHook url.

Show all
Copy parameter's URL WebHook WebHook
Optional

String Set WebHook URL to call after conversion is finished. Also works for synchronous requests.

Show all
Copy parameter's URL Password Open Password
Optional

String Sets the password to open protected documents.

Show all
Copy parameter's URL PageRange Page Range
Optional

String Set page range.

Default: 1-2000

Show all
Copy parameter's URL PageOrientation Page orientation
Optional

Collection Page orientation.

Default: default

Values: default, portrait, landscape

Show all
Copy parameter's URL PageSize Page size
Optional

Collection Page size.

Default: default

Values: default, letter, lettersmall, tabloid, ledger, legal, statement, executive, a3, a4, a4small, a5, b4, b5, folio, quarto, 10x14, 11x17, note, envelope9, envelope10, envelope11, envelope12, envelope14, csheet, dsheet, esheet, envelopedl, envelopec3, envelopec4, envelopec5, envelopec6, envelopec65, envelopecb4, envelopeb5, envelopeb6, envelopeeurope, envelopem, envelopeusa, fanfoldusa, fanfoldgerman, lfanfoldgerman

Show all
Copy parameter's URL ConvertMetadata Convert metadata
Optional

Bool Convert document metadata like Title, Author, Keywords to PDF metadata.

Default: True

Show all
Copy parameter's URL ConvertTags Convert accessibility tags
Optional

Bool Convert document structure tags for accessibility.

Default: False

Show all
Copy parameter's URL PdfTitle PDF title
Optional

String Set the title of the generated PDF file. If value is not set a source document title is used instead.

Show all
Copy parameter's URL PdfSubject PDF subject
Optional

String Set the subject of the generated PDF file. If value is not set a source document subject is used instead.

Show all
Copy parameter's URL PdfAuthor PDF author
Optional

String Set the author of the generated PDF file. If value is not set a source document author is used instead.

Show all
Copy parameter's URL PdfKeywords PDF keywords
Optional

String Set the keywords of the generated PDF file. If value is not set a source document keywords are used instead.

Show all
Copy parameter's URL PdfaVersion PDF/A version
Optional

Collection Set PDF/A version.

Default: pdfa2

Values: pdfa, pdfa2, pdfa3

Show all
Copy parameter's URL PdfaOutputIntent PDF/A output intent
Optional

Collection Set PDF/A output intent. These are supported sRGB, Japan Color 2001 Coated (JC200103), Europe ISO Coated (FOGRA27), U.S. Web Coated (SWOP), Gray Gamma 2.2 (GRAY).

Default: srgb

Values: srgb, jc200103, fogra27, swop, gray

Show all

Show parameters

Snippets are autogenerated according to converter parameter choices above. Please select file in "File" or "Files" parameter before using code snippets.

Code snippet is using ConvertAPI JavaScript Client

Code snippet is using ConvertAPI Node.js Client

Code snippet is using ConvertAPI PHP Client

Code snippet is using ConvertAPI Java Client

Code snippet is using ConvertAPI C# Client

Code snippet is using ConvertAPI Ruby Client

Code snippet is using ConvertAPI Python Client

Code snippet is using ConvertAPI Go Client

Code snippet is using command line utility program

For conversions with the multiple file result please refer to the example