Remove Watermarks

Introduction

This REST API allows removing watermarks from the document.

The operation performs a search for possible watermarks and then removes them.

The API supports a rich set of search criteria that allows finding images and texts that may be possible watermarks.

There are two popular scenarios to use the Remove operation:

1. Remove particular watermarks found by search criteria. With this scenario Two operations are used: Search and Remove:
   1. You define the search criteria set;
   2. You first use Search operation with the designed criteria and get the response with search results;
   3. You can analyze the response and choose those watermarks that should be deleted;
   4. You then call Remove operation with the same set of search criteria;
   5. You also provide RemoveIds array with IDs of found watermarks;
   6. Then watermarks with passed IDs will be removed
2. Remove all found watermarks. With this scenario:
   1. You define search criteria and pass them as parameters
   2. You don’t provide RemoveIds array
   3. Then all the found watermarks will be removed

The table below contains the full list of properties.

In case the array is not passed, all the found possible watermarks are removed.

ColorRange

Color

Resource URI

HTTP POST ~~/watermark/remove

Swagger UI lets you call this REST API directly from the browser.

cURL Example

# First get JSON Web Token
# Please get your Client Id and Client Secret from https://dashboard.groupdocs.cloud/applications.
# Kindly place Client Id in "client_id" and Client Secret in "client_secret" argument.
curl -v "https://api.groupdocs.cloud/connect/token" \
-X POST \
-d "grant_type#client_credentials&client_id#xxxx&client_secret#xxxx" \
-H "Content-Type: application/x-www-form-urlencoded" \
-H "Accept: application/json"
   
# cURL example to get document information
curl -v "https://api.groupdocs.cloud/v1.0/watermark/remove" \
-X POST \
-H "Content-Type: application/json" \
-H "Accept: application/json" \
-H "Authorization: Bearer <jwt token>"
-d "{
    "FileInfo": {
        "FilePath": "with_watermarks\\sample.pdf"
    },
    "OutputFolder": "removed_watermarks",
    "TextSearchCriteria": {
        "SearchText": "Watermark text"
    },
    "ImageSearchCriteria": {
        "ImageFileInfo": {
            "FilePath": "watermark_images\\sample_watermark.png",
            "StorageName": ""
        }
    }
}"

{
    "downloadUrl": "https://api.groupdocs.cloud/v1.0/watermark/storage/file/removed_watermarks/sample_pdf/sample.pdf",
    "path": "removed_watermarks/sample_pdf/sample.pdf"
}

SDKs

Our API is completely independent of your operating system, database system or development language. You can use any language and platform that supports HTTP to interact with our API. However, manually writing client code can be difficult, error-prone and time-consuming. Therefore, we have provided and support API SDKs in many development languages in order to make it easier to integrate with us. If you use SDK, it Removes the Watermark API calls and lets you use GroupDocs Cloud features in a native way for your preferred language.

SDK Examples