Skip to main content

Draw a watermark image inside the PDF.

POST 
/pdf/watermark/image

Draw a watermark image inside the PDF.

Request​

Header Parameters

    ipaas string

Bodyrequired

    urlstring

    The PDF URL.

    bufferstring

    The PDF as a Base64-encoded buffer. Can be specified instead of url.

    getAsUrlboolean

    Whether the result PDF should be returned as a URL. Default is false.

    Example: true
    repeatboolean

    Repeats the image across the entire specified range of the PDF. Default is false

    Example: true
    imageUrlstring

    The URL of the image to draw.

    imageBufferstring

    The image as a Base64-encoded buffer. Can be specified instead of imageUrl.

    anchorstring

    The part of the page on which the image should be drawn. Default is center.

    Possible values: [bottom-left, bottom, bottom-right, left, center, right, top-left, top, top-right]

    Example: center
    alignstring

    The part of the image that should be aligned with the specified position. Default is the value of anchor.

    Possible values: [bottom-left, bottom, bottom-right, left, center, right, top-left, top, top-right]

    Example: center
    xnumber

    The horizontal offset in points relative to the anchor. Default is 0.

    Example: 0
    ynumber

    The vertical offset in points relative to the anchor. Default is 0.

    Example: 0
    widthnumber

    The width of the image in points. This or height has to be provided. If only width is provided, height is calculated automatically.

    Example: 200
    heightnumber

    The height of the image in points. This or width has to be provided. If only height is provided, width is calculated automatically.

    Example: 100
    rotatenumber

    The counter-clockwise rotation of the image in degrees. Default is 0.

    Example: 45
    spacingnumber

    The space between each image. It only applies if repeat is true. Default is 0.

    Example: 45
    opacitynumber

    The opacity of the given image. The range must be between 0 and 1. Default is 1.

    Example: 0.2
    pagesstring

    The pages the image should be drawn onto. Given as a range of pages, where 1 means the first page and ^1 means the last page. Default are all Pages.

    fileNamestring

    The file name the result PDF will have. Default is a random ID.

Responses​

Success

Schema
    object