On this page

Show all

Help Center/ Data Security Center/ API Reference/ API Description/ Document Watermarking/ Extracting Invisible Watermarks

Extracting Invisible Watermarks

Updated on 2023-12-07 GMT+08:00

View PDF

Function

This API is used to extract invisible watermarks from Word (.docx), PPT (.pptx), Excel (.xlsx), and PDF (.pdf) files. You need to pass watermarked formData files to this API, DSC returns extracted text watermarks in JSON format.

URI

POST /v1/{project_id}/sdg/doc/watermark/extract

**Table 1** Path Parameters
Parameter	Mandatory	Type	Description
project_id	Yes	String	Project ID.

Request Parameters

**Table 2** Request header parameters
Parameter	Mandatory	Type	Description
X-Auth-Token	Yes	String	User token, which can be obtained by calling the IAM API (value of X-Subject-Token in the response header).

**Table 3** FormData parameters
Parameter	Mandatory	Type	Description
doc_type	Yes	String	Type of the document from which a watermark needs to be extracted. Enumeration values: WORD EXCEL PDF PPT
file_password	No	String	Password for opening a file, which can contain a maximum of 256 characters. Opening a watermarked file does not require a password. If an Office Word document requires a password for read or domain control, you need to enter the password to open the file.
file	Yes	File	File to be uploaded for watermark extraction.

Response Parameters

Status code: 200

**Table 4** Response body parameters
Parameter	Type	Description
watermark	String	Invisible watermark. The length cannot exceed 32 characters.

Status code: 400

**Table 5** Response body parameters
Parameter	Type	Description
error_code	String	Error Code
error_msg	String	Error Message

Example Requests

Extract the invisible watermark of the testMarked.doc file whose document type is word.

NOTE:

The request is submitted through a form. In the request, "file" indicates a specific file.

POST /v1/{project_id}/sdg/doc/watermark/extract

{
  "file" : "testMarked.doc",
  "doc_type" : "WORD"
}

Example Responses

Status code: 200

Request successful.

{
  "watermark" : "mark!"
}

Status code: 400

Invalid request.

{
  "error_code" : "DSC.00000007",
  "error_msg" : "File format error"
}

Status Codes

Status Code	Description
200	Request successful.
400	Invalid request.

Error Codes

See Error Codes.

Parent topic: Document Watermarking

Previous topic: Injecting Watermarks into Documents

Next topic: Injecting Watermarks into Documents (Document Addresses)

Feedback

Was this page helpful?

Helpful Not helpful

Provide feedback

Thank you very much for your feedback. We will continue working to improve the documentation.

The system is busy. Please try again later.

Which of the following issues have you encountered?

Content is inconsistent with the product UI

Unclear descriptions

Lack of examples or code

Incorrect steps

Can't find what I need

Lack of best practices

Feedback (optional)

0/500

Select at least one type of issue, and enter your comments or suggestions.

Enter a maximum of 500 characters.

Submit Cancel