PDF to WATERMARK API.

Watermark PDF files. Stamp a PDF with the text and graphic.

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
Document Options Parameters
Parameter Description Value
DocumentPassword

Optional

String

Sets the password to open protected documents.

DocumentPassword
Watermark Options Parameters
Parameter Description Value
Text

Optional

String

Specifies the text to use as watermark. The list of supported variables: %PAGE% - current page number, %PAGES% - total number of pages, %FILENAME% - name of the file, %WEEKDAY% - full weekday name, %WEEKDAY_SHORT% - abbreviated weekday name, %MONTH% - month number (1-12), %MONTHNAME% - full month name, %MONTHNAME_SHORT% - abbreviated month name, %YEAR% - year with century (YYYY), %YEAR_SHORT% - year without century (YY), %DAY% - day of month, %DAY_YEAR% - day of the year (1 -366), %HOUR% - hour (01- 12), %HOURS% - hour (00-23), %MINUTES% - minutes (00-59), %SECONDS% - seconds (00-59), %AMPM% - AM PM, %DATE% - local date representation, %TIME% - local time representation, %DATETIME% - local date and time, %AUTHOR% - document Author, %TITLE% - document Title, %SUBJECT% - document Subject, %KEYWORDS% - document Keywords.

Text
FontName

Optional

Collection

Specifies the watermark font name.

Default: Arial

Values: Academy Engraved LET, Agency FB, Aharoni, Aldhabi, Algerian, American Typewriter, Andalus, Angsana New, AngsanaUPC, Aparajita, Arabic Typesetting, Arial, Arial Black, Arial Narrow, Arial Rounded MT Bold, Arimo, Avenir LT Std 35 Light, Avenir LT Std 45 Book, Avenir LT Std 55 Roman, Avenir LT Std 65 Medium, AvenirNext LT Pro Bold, AvenirNext LT Pro Cn, AvenirNext LT Pro HeavyCn, AvenirNext LT Pro MediumCn, AvenirNext LT Pro Regular, AvenirNext LT Pro UltLightCn, Baskerville, Baskerville BT, Baskerville Old Face, Batang, BatangChe, Bauhaus 93, Bell MT, Berlin Sans FB, Berlin Sans FB Demi, Bernard MT Condensed, Binner Gothic, Blackadder ITC, Bodoni, Bodoni Bd BT, Bodoni BdCn BT, Bodoni Bk BT, Bodoni BT, Bodoni MT, Bodoni MT Black, Bodoni MT Condensed, Bodoni MT Poster Compressed, Book Antiqua, Bookman Old Style, Bookshelf Symbol 7, Botanical, Bradley Hand ITC, Britannic Bold, Broadway, Browallia New, BrowalliaUPC, Brush Script, Brush Script MT, Calibri, Calibri Light, Californian FB, Calisto MT, Cambria, Cambria Math, Candara, Castellar, Centaur, Century, Century Gothic, Century Schoolbook, ChalkDust, Chiller, Cochin LT, Colonna MT, Comic Sans MS, Consolas, Constantia, Cooper Black, Copperplate Gothic Bold, Copperplate Gothic Light, Corbel, Cordia New, CordiaUPC, Courier New, Curlz MT, DaunPenh, David, DejaVu Sans, DejaVu Sans Condensed, DejaVu Sans Light, DejaVu Sans Mono, DejaVu Serif, DejaVu Serif Condensed, DFKai-SB, Didot, DilleniaUPC, DIN Alternate, DIN Condensed, DokChampa, Dotum, DotumChe, Ebrima, Edwardian Script ITC, Elephant, Engravers MT, Eras Bold ITC, Eras Demi ITC, Eras Light ITC, Eras Medium ITC, Estrangelo Edessa, EucrosiaUPC, Euphemia, FangSong, Felix Titling, Footlight MT Light, Forte, Franklin Gothic Book, Franklin Gothic Demi, Franklin Gothic Demi Cond, Franklin Gothic Heavy, Franklin Gothic Medium, Franklin Gothic Medium Cond, FrankRuehl, FreesiaUPC, Freestyle Script, French Script MT, Frutiger 55, Frutiger 56, Frutiger 57 Condensed, Frutiger 65, Frutiger 66, Frutiger 67 Condensed, Frutiger 75 Black, Frutiger 76 Black, Frutiger 77 Black Condensed, Frutiger LT Com 47 LightCn, Frutiger LT Com 55 Roman, Frutiger LT Com 57 Condensed, Frutiger LT Pro 45 Light, Frutiger LT Pro 55 Roman, Futura, Futura BdCn BT, Futura Bk BT, Futura CondensedLight, Futura Hv BT, Futura Lt BT, Futura LtCn BT, Futura Md BT, Futura MdCn BT, Futura XBlk BT, Futura XBlkCnIt BT, Futura-Black, Gabriola, Gadugi, Garamond, Gautami, Gentium Basic, Gentium Book Basic, Georgia, Gigi, Gill Sans, Gill Sans Condensed, Gill Sans MT, Gill Sans MT Condensed, Gill Sans MT Ext Condensed Bold, Gill Sans Ultra Bold, Gill Sans Ultra Bold Condensed, Gisha, Gloucester MT Extra Condensed, Goudy Old Style, Goudy Stout, Gulim, GulimChe, Gungsuh, GungsuhChe, Haettenschweiler, Harlow Solid Italic, Harrington, High Tower Text, Hoefler Text, Impact, Imprint MT Shadow, Informal Roman, IowanOldSt BT, IrisUPC, Iskoola Pota, JasmineUPC, Javanese Text, Jokerman, Juice ITC, KaiTi, Kalinga, Kartika, Khmer UI, KodchiangUPC, Kokila, Kristen ITC, Kunstler Script, Lao UI, Latha, Leelawadee, Leelawadee UI, Leelawadee UI Semilight, Letter Gothic, Levenim MT, LilyUPC, Lotus Postal Barcode, LotusWP Box, LotusWP Icon, LotusWP Int A, LotusWP Int B, LotusWP Type, Lucida Bright, Lucida Calligraphy, Lucida Console, Lucida Fax, Lucida Handwriting, Lucida Sans, Lucida Sans Typewriter, Lucida Sans Unicode, Lydian, Magneto, Maiandra GD, Malgun Gothic, Mangal, Marker Felt, Marlett, Math A, Math B, Math C, Matura MT Script Capitals, Meiryo, Meiryo UI, Microsoft Himalaya, Microsoft JhengHei, Microsoft JhengHei Light, Microsoft JhengHei UI, Microsoft JhengHei UI Light, Microsoft New Tai Lue, Microsoft PhagsPa, Microsoft Sans Serif, Microsoft Tai Le, Microsoft Uighur, Microsoft YaHei, Microsoft YaHei Light, Microsoft YaHei UI, Microsoft YaHei UI Light, Microsoft Yi Baiti, MingLiU, MingLiU-ExtB, MingLiU_HKSCS, MingLiU_HKSCS-ExtB, Miriam, Miriam Fixed, Mistral, Modern No. 20, Mongolian Baiti, Monotype Corsiva, Monotype Sorts, MoolBoran, MS Gothic, MS Mincho, MS PGothic, MS PMincho, MS Reference Sans Serif, MS Reference Specialty, MS UI Gothic, MT Extra, MV Boli, Myanmar Text, Narkisim, News Gothic, News Gothic Condensed, Niagara Engraved, Niagara Solid, Nimrod, Nirmala UI, Nirmala UI Semilight, NSimSun, Nyala, OCR A Extended, Old English Text MT, Onyx, OpenSymbol, OPTICopperplate, OPTICopperplate Heavy, OPTICopperplate-Light, Optima, Palace Script MT, Palatino, Palatino Linotype, Papyrus, Parchment, Perpetua, Perpetua Titling MT, Photina Casual Black, Plantagenet Cherokee, Playbill, PMingLiU, PMingLiU-ExtB, Poor Richard, Pristina, PT Serif, Raavi, Rage Italic, Ravie, Rockwell, Rockwell Condensed, Rockwell Extra Bold, Rockwell Light, Rod, Sakkal Majalla, Script MT Bold, Segoe Print, Segoe Script, Segoe UI, Segoe UI Black, Segoe UI Emoji, Segoe UI Light, Segoe UI Semibold, Segoe UI Semilight, Segoe UI Symbol, Seriffic Grunge, Shonar Bangla, Showcard Gothic, Shruti, SimHei, Simplified Arabic, Simplified Arabic Fixed, SimSun, SimSun-ExtB, Sitka Banner, Sitka Display, Sitka Heading, Sitka Small, Sitka Subheading, Sitka Text, Snap ITC, Source Code Pro, Source Code Pro Black, Source Code Pro ExtraLight, Source Code Pro Light, Source Code Pro Medium, Source Code Pro Semibold, Source Sans Pro, Source Sans Pro Black, Source Sans Pro ExtraLight, Source Sans Pro Light, Source Sans Pro Semibold, Stencil, Superclarendon Rg, Sylfaen, Symbol, Tahoma, Tempus Sans ITC, Times New Roman, Traditional Arabic, Trebuchet MS, Tunga, Tw Cen MT, Tw Cen MT Condensed, Tw Cen MT Condensed Extra Bold, Urdu Typesetting, Utsaah, Vani, Verdana, Vijaya, Viner Hand ITC, Vivaldi, Vladimir Script, Vrinda, Webdings, Wide Latin, Wingdings, Wingdings 2, Wingdings 3, Yu Gothic, Yu Gothic Light, Yu Mincho, Yu Mincho Demibold, Yu Mincho Light, Zapfino

FontName
FontSize

Optional

Integer

Specifies the watermark font size.

Default: 18

Values: 1 .. 200

FontSize
FontColor

Optional

String

Specifies the watermark font color.

Default: #000000

FontColor
FontEmbed

Optional

Bool

Specifies whether fonts should be embedded.

Default: False

FontEmbed
Rotate

Optional

Integer

Specifies the watermark rotation angle in degrees.

Default: 0

Values: 0 .. 360

Rotate
PlaceOnPages

Optional

String

Specifies the pages to place watermark. Page numbers must be separated by commas, example 1,2,5. A watermark placed on all pages if page number is not specified.

PlaceOnPages
HorizontalAlignment

Optional

Collection

Specifies the horizontal watermark alignment.

Default: center

Values: left, center, right

HorizontalAlignment
VerticalAlignment

Optional

Collection

Specifies the vertical watermark alignment.

Default: bottom

Values: top, center, bottom

VerticalAlignment
PositionX

Optional

Integer

Specifies the watermark X coordinate. If set overrides property HorizontalAlignment.

Values: 1 .. 10000

PositionX
PositionY

Optional

Integer

Specifies the watermark Y coordinate. If set overrides property VerticalAlignment.

Values: 1 .. 10000

PositionY
PositionUnit

Optional

Collection

Specifies measurement unit to use for the PositionX and PositionY properties.

Default: pt

Values: pt, in, mm, cm

PositionUnit
Opacity

Optional

Integer

Specifies watermark opacity level.

Default: 100

Values: 0 .. 100

Opacity
PDF Output Parameters
Parameter Description Value
PdfVersion

Optional

Collection

Set PDF version.

Default: 1.5

Values: 1.2, 1.3, 1.4, 1.5, 1.6, 1.7

PdfVersion
PdfResolution

Optional

Integer

Set PDF resolution.

Default: 300

Values: 10 .. 2400

PdfResolution
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

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