DOC to PDFA API.

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

API Request

Authentication Parameters
Parameter Description Value
Secret

Optional

String

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

 Secret
Token

Optional

String

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

 Token
Input Parameters
Parameter Description Value
File

Required

File

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

 File
Output Parameters
Parameter Description Value
StoreFile

Optional

Bool

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

Default: False

StoreFile
FileName

Optional

String

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

 FileName
Execution Parameters
Parameter Description Value
Timeout

Optional

Integer

Conversion timeout in seconds.

Default: 300

Values: 10 .. 1200

Timeout
Asynchronous Parameters
Parameter Description Value
Async

Optional

Bool

Run conversion job asynchronously.

Default: False

Async
JobId

Optional

String

Conversion job self generated UUID (RFC 4122) used for getting conversion result asynchronously.

 JobId
WebHook

Optional

String

Set WebHook URL to call after asynchronous conversion is finished. Async parameter must be enabled.

 WebHook
Word Options Parameters
Parameter Description Value
DocumentPassword

Optional

String

Sets the password to open protected documents.

 DocumentPassword
PageRange

Optional

String

Set page range.

Default: 1-999

PageRange
PageOrientation

Optional

Collection

Page orientation.

Default: default

Values: default, portrait, landscape

PageOrientation
PageSize

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

PageSize
ConvertMetadata

Optional

Bool

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

Default: True

ConvertMetadata
PDF Output Parameters
Parameter Description Value
PdfTitle

Optional

String

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

 PdfTitle
PdfSubject

Optional

String

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

 PdfSubject
PdfAuthor

Optional

String

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

 PdfAuthor
PdfKeywords

Optional

String

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

 PdfKeywords
PdfaVersion

Optional

Collection

Set PDF/A version.

Default: PDFA

Values: pdfa, pdfa2

PdfaVersion
PdfaOutputIntent

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

PdfaOutputIntent

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 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