ConvertApi Logo
Sign up

DOC to PDFA API

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

DOC PDFA

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

Advanced properties
Copy parameter's URL Secret Secret
Type: String

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

Show all
Copy parameter's URL Token Token
Type: 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
Type: File

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

Show all
Copy parameter's URL StoreFile Store file
Type: Bool

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

Default: False Show all
Copy parameter's URL FileName File name
Type: String

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

Show all
Copy parameter's URL Timeout Timeout
Type: Integer

Conversion timeout in seconds.

Default: 900 Range: 10 .. 1200 Show all
Copy parameter's URL Password Open Password
Type: String

Sets the password to open protected documents.

Show all
Copy parameter's URL PageRange Page Range
Type: String

Set page range.

Default: 1-2000 Show all
Copy parameter's URL PageOrientation Page orientation
Type: Collection

Page orientation.

Default: default Values: default portrait landscape Show all
Copy parameter's URL PageSize Page size
Type: 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
Type: Bool

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

Default: True Show all
Copy parameter's URL ConvertTags Convert accessibility tags
Type: Bool

Convert document structure tags for accessibility.

Default: False Show all
Copy parameter's URL PdfTitle Set PDF title
Type: String

Provide a value to customize the PDF title. Otherwise, the default document title will be used. Use single quotes and a space (' ') to remove the title.

Show all
Copy parameter's URL PdfSubject Set PDF subject
Type: String

Provide a value to customize the PDF subject. Otherwise, the default document subject will be used. Use single quotes and a space (' ') to remove the subject.

Show all
Copy parameter's URL PdfAuthor Set PDF author
Type: String

Provide a value to customize the PDF author. Otherwise, the default document author will be used. Use single quotes and a space (' ') to remove the author.

Show all
Copy parameter's URL PdfKeywords Set PDF keywords
Type: String

Provide a value to customize the PDF keywords. Otherwise, the default document keywords will be used. Use single quotes and a space (' ') to remove the keywords.

Show all
Copy parameter's URL PdfaVersion PDF/A version
Type: Collection

Set PDF/A version.

Default: pdfa2 Values: pdfa pdfa2 pdfa3 Show all
Copy parameter's URL PdfaOutputIntent PDF/A output intent
Type: 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

Code snippet

// Code snippet is using the ConvertAPI JavaScript Client: https://github.com/ConvertAPI/convertapi-js

// Code snippet is using the ConvertAPI Node.js Client: https://github.com/ConvertAPI/convertapi-nodejs

// Code snippet is using the ConvertAPI PHP Client: https://github.com/ConvertAPI/convertapi-php

// Code snippet is using the ConvertAPI Java Client: https://github.com/ConvertAPI/convertapi-java

// Code snippet is using the ConvertAPI C# Client: https://github.com/ConvertAPI/convertapi-dotnet

# Code snippet is using the ConvertAPI Ruby Client: https://github.com/ConvertAPI/convertapi-ruby

# Code snippet is using the ConvertAPI Python Client: https://github.com/ConvertAPI/convertapi-python

// Code snippet is using the ConvertAPI Go Client: https://github.com/ConvertAPI/convertapi-go

REM Code snippet is using the command line utility program: https://github.com/ConvertAPI/convertapi-cli

<!-- For conversions with the multiple file result please refer to this example: https://repl.it/@ConvertAPI/HTML-Form-with-multiple-file-result -->