Redact document

POST {{baseUrl}}/api/{{apiV3Version}}/document-tool/:document-id/pdf-redactor

Redact or highlight a PDF by a configuration of the following information:

  • Keywords
  • Pages
  • Areas

Request Body

namerequireddescription
redactTextsfalseWords to be redacted.
redactTextPagesfalsePages to be redacted
redactRectArrayfalseCoordinates of squares to be masked
highlightfalseWhether to use highlight mode (true) or redaction (false) mode.

Request Body

{"redactTexts"=>["Confidential", "information"], "redactTextPages"=>[1, 3], "redactRectArray"=>[[0, 534, 747, 587, 759]], "highlight"=>true}

HEADERS

KeyDatatypeRequiredDescription
{{idoxAPIKey}}stringPlease sign-up iDox.ai and get an API key.