Watermark PDF

The file parameter allows you to select a local file to be uploaded to pdfRest’s processing server.

The id parameter allows you to submit a resource ID generated by one of our API Tools. Each of our API Tools assigns a unique resource ID to your output file(s), allowing you to chain requests together without having to download intermediate files between requests.

For example, you can submit the output ID you receive from our Convert to PDF tool to watermark your new PDF document.

The watermark_text parameter lets you submit text to add as a watermark into your document.

The following parameters allow you to further adjust your text watermark:

• font - set the font of your text watermark
• text_size - set the font size
• text_color_rgb or text_color_cmyk - set text color
• opacity - set text opacity
• x and y - horizontal and vertical offset, respectively
• rotation - apply rotation to your text watermark

The watermark_file parameter lets you upload a PDF to pdfRest's processing server to be added as a watermark to your input document.

To add an image file as a watermark to a PDF, you can use pdfRest's Convert to PDF tool to convert a JPG, PNG, TIF, or BMP file to PDF and submit it here using the watermark_file or watermark_file_id parameter.

The following parameters allow you to further adjust your file watermark:

• watermark_file_scale - apply a size multiplier to your file watermark
• opacity - set watermark opacity
• x and y - horizontal and vertical offset, respectively, from the center of the page
• rotation - apply rotation to your watermark

The watermark_file_id parameter allows you to submit a resource ID generated by one of our API Tools. The file associated with the resource ID will be applied to your input document as a PDF watermark.

To add an image file as a watermark to a PDF, you can use pdfRest's Convert to PDF tool to convert a JPG, PNG, TIF, or BMP file to PDF and submit it here using the watermark_file or watermark_file_id parameter.

The following parameters allow you to further adjust your file watermark:

• watermark_file_scale - apply a size multiplier to your file watermark
• opacity - set watermark opacity
• x and y - horizontal and vertical offset, respectively, from the center of the page
• rotation - apply rotation to your watermark

The output parameter lets you set a filename (without extension) for your watermarked PDF.

The text_size parameter sets the font size of a text watermark.

This parameter accepts an integer value from 5 to 100. For example, setting the value to 20 will make the text font size 20. The parameter is optional and defaults to 72.

The font parameter sets the font for a text watermark.

This parameter accepts a string representing the name of a supported font. For a complete list of fonts, see our Font List. For example, setting the value to CourierStd will use that font for the watermark. The parameter is optional and defaults to Arial.

The text_color_rgb parameter sets the color of a text watermark using the RGB color model. You provide three comma-separated integer values for Red, Green, and Blue, with each value ranging from 0 to 255.

This parameter is mutually exclusive with text_color_cmyk; you can only use one to define the color. For example, 255,0,0 produces the color red. This parameter is optional and defaults to 0,0,0 (black).

The text_color_cmyk parameter sets the color of a text watermark using the CMYK color model. You provide four comma-separated values for Cyan, Magenta, Yellow, and Key (Black), with each value ranging from 0 to 100.

This parameter is mutually exclusive with text_color_rgb; you can only use one to define the color. For example, 100,0,0,0 produces a pure cyan color. If neither a CMYK nor an RGB color is specified, the tool uses a default value for the text_color_rgb parameter, meaning text_color_cmyk has no default value of its own.

The watermark_file_scale parameter lets you resize a PDF watermark file.

This parameter accepts any non-negative number as a value. A value of 1.0 maintains the original size of the PDF watermark. Values greater than 1.0 will enlarge the watermark, while values less than 1.0 will shrink it. For example, a value of 2.25 will make the watermark 225% of its original size. The parameter is optional and defaults to 0.5, which reduces the watermark to 50% of its original size.

The opacity parameter controls the transparency of a watermark, which applies to both text and image-based watermarks.

This parameter accepts a decimal value from 0.0 to 1.0. A value of 0.0 makes the watermark completely transparent and invisible, while 1.0 makes it fully opaque. For example, a value of 0.75 will make the watermark 75% opaque. The parameter is optional and defaults to 0.5 (50% opaque).

The x parameter sets a horizontal offset for the watermark from the center of the page. This value is measured in PDF units, with 72 units equaling one inch. A positive value will shift the watermark to the right, while a negative value will shift it to the left.

For example, a value of -72 will place the watermark 72 PDF units (one inch) to the left of the page's center. This parameter is optional and defaults to 0, which centers the watermark horizontally on the page.

The y parameter sets a vertical offset for the watermark from the center of the page. This value is measured in PDF units, where 72 units are equal to one inch. A positive value will move the watermark up, while a negative value will move it down.

For example, a value of 150 will place the watermark 150 PDF units above the center of the page. This parameter is optional and defaults to 0, which centers the watermark vertically on the page.

The rotation parameter lets you rotate a watermark in degrees. This applies to both text and image-based watermarks.

You can set the rotation to any integer value. For example, a value of 45 will rotate the watermark 45 degrees. The parameter is optional and defaults to 0 degrees, which means no rotation is applied.

The pages parameter lets you specify exactly which pages of a PDF document should have a watermark applied. Instead of watermarking every page by default, this parameter gives you precise control.

You can use the pages parameter to target specific pages or a range of pages. The parameter accepts a comma-separated list of individual page numbers or page ranges. You can also use the keyword "last" to represent the final page of the document.

Examples:

• 14-last: Watermarks pages 14 through to the end of the document.
• 2-9: Watermarks pages 2 through 9.
• 1,2,5-10,12-last: Watermarks pages 1 and 2, pages 5 through 10, and pages 12 through to the end.

The parameter is optional. If you don't use it, the API will apply the watermark to all pages by default (equivalent to 1-last).

The behind_page parameter controls the placement of the watermark relative to the existing PDF content. By default, the watermark is placed on top of all other content on the page, but this parameter allows you to change that.

Setting this parameter to true will place the watermark behind all other page content. This is useful for watermarks that should be visible but not obscure the primary content. Setting it to false will place the watermark on top of the page content.

Accepted values:

• true: Places the watermark behind the page content.
• false: Places the watermark on top of the page content.

The parameter is optional and defaults to false.