ConvertApi Logo
Sign up

Overlay Watermark PDF API

Overlay your PDF with Watermark

PDF

Add PDF Watermark using PDF Page Overlay easily with Overlay Watermark PDF API.

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 OverlayFile Overlay PDF file Required
Type: File

Specifies the PDF file to use as overlay. Value can be URL or file content.

Show all
Copy parameter's URL OverlayPage Overlay PDF page
Type: Integer

Specifies the page to use as overlay from the OverlayFile file.

Default: 1 Range: 1 .. 2000 Show all
Copy parameter's URL Scale Scale watermark
Type: Integer

Specifies the watermark scale in percent.

Default: 100 Range: 0 .. 2000 Show all
Copy parameter's URL PageRange Page Range
Type: String

Set page range. Example 1-10 or 1,2,5.

Default: 1-2000 Show all
Copy parameter's URL Opacity Opacity level
Type: Integer

Specifies watermark opacity level.

Default: 100 Range: 0 .. 100 Show all
Copy parameter's URL Style Watermark style
Type: Collection

Specifies watermark style, stamp or watermark. The stamp is placed over page content and watermark under page content.

Default: watermark Values: stamp watermark Show all
Copy parameter's URL GoToLink Go to web link
Type: String

Specifies the web address to go when the watermark is clicked.

Show all
Copy parameter's URL GoToPage Go to page
Type: String

Specifies the page number to go when the watermark is clicked.

Show all
Copy parameter's URL PageRotation Use page rotation
Type: Bool

Specifies whether to use the page rotation parameter when placing watermark.

Default: False Show all
Copy parameter's URL CropBox Use crop box
Type: Bool

Specifies whether to use the page crop box to position watermark.

Default: False Show all
Copy parameter's URL HorizontalAlignment Horizontal watermark alignment
Type: Collection

Specifies the horizontal watermark alignment.

Default: center Values: left center right Show all
Copy parameter's URL VerticalAlignment Vertical watermark alignment
Type: Collection

Specifies the vertical watermark alignment.

Default: center Values: top center bottom Show all
Copy parameter's URL PositionX Watermark X coordinate
Type: Integer

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

Range: 1 .. 10000 Show all
Copy parameter's URL PositionY Watermark Y coordinate
Type: Integer

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

Range: 1 .. 10000 Show all
Copy parameter's URL PositionUnit Watermark position unit
Type: Collection

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

Default: pt Values: pt in mm cm Show all
Copy parameter's URL EmbedFonts Embed fonts
Type: Bool

Embed fonts in PDF.

Default: True Show all
Copy parameter's URL SubsetFonts Subset fonts
Type: Bool

Include in the output PDF document only the font characters that are used in the original document.

Default: True Show all
Copy parameter's URL SubsetFontsThreshold Subset fonts threshold
Type: Integer

Sets the Subset Fonts threshold. If the percentage of used characters, compared with total characters of the particular font, exceeds this threshold, the entire font is embedded.

Default: 100 Range: 0 .. 100 Show all
Copy parameter's URL PdfVersion PDF version
Type: Collection

Set PDF version.

Default: 1.5 Values: 1.2 1.3 1.4 1.5 1.6 1.7 1.8 2.0 Show all
Copy parameter's URL PdfResolution PDF resolution
Type: Integer

Set PDF resolution.

Default: 300 Range: 10 .. 2400 Show all
Copy parameter's URL PdfTitle PDF title
Type: 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
Type: 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
Type: 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
Type: 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 OpenPage Open to page
Type: Integer

Set the page number at which the PDF document should open.

Default: 1 Range: 1 .. 3000 Show all
Copy parameter's URL OpenZoom PDF default zoom
Type: Collection

Set the default zoom percentage for when you open PDF files .

Default: Default Values: Default ActualSize FitPage FitWidth FitHeight FitVisible 25 50 75 100 125 150 200 400 800 1600 2400 3200 6400 Show all
Copy parameter's URL RotatePage Auto rotate page
Type: Collection

Automatically rotate pages based on the orientation of the text. By Page option will rotate each page based on the direction of the text on that page. All option will rotate all pages in the document based on the orientation of the majority of text.

Default: ByPage Values: Disabled ByPage All Show all
Copy parameter's URL ColorSpace PDF color space
Type: Collection

Set PDF color space.

Default: Default Values: Default RGB CMYK 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 -->