Redaction

Create Redactions

Use this endpoint to add multiple redaction annotations in a single request.

Available strategies are:

  • preset - creates redactions on top of text and annotations matching the predefined pattern. For the full list of presets, see the request schema.
  • regex - creates redactions on top of text and annotations matching the provided regular expression. The regular expressions needs to comply with the ICU regex standard.
  • text - creates redactions on top of text and annotations matching the provided string search term. Note that the search is case-insensitive.

The shape of the strategyOptions depends on the chosen strategy. Currently each strategy supports the includeAnnotations options (true by default), which controls whether redactions should also cover annotations whose content match the search query.

The user_id key allows to specify the owner of the newly created annotations, and content allows to override their visual properties.

On success, an array of created redaction annotations is returned.

post/api/documents/{documentId}/redactions

Request

  • Base URL: http://localhost:5000
  • URL: http://localhost:5000/api/documents/{documentId}/redactions
  • Auth: one of:
    • API key in header Authorization
    • HTTP bearer

Path parameters

documentIdstring required

The document ID

Headers

pspdfkit-pdf-passwordstring

The PDF document password.

The value can be either a plain-text password or a base64 encoded password in a form base64:<encoded-password>. Use the Base64 encoding if your password contains characters that are not allowed in HTTP header or would be otherwise mangled (e.g. trailing or leading spaces)

If the document is password protected, any operations performed on it require supplying a password.

Request body

OR
OR

Example request

{
  "strategyOptions": {
    "preset": "email-address"
  },
  "content": {
    "bbox": [
      255.10077620466092,
      656.7566095695641,
      145.91672653256705,
      18.390804597701162
    ],
    "action": {
      "relativePath": "/other_document.pdf"
    },
    "id": "01DNEDPQQ22W49KDXRFPG4EPEQ",
    "createdAt": "2019-09-16T15:05:03.712909Z",
    "updatedAt": "2019-09-16T15:05:03.712909Z",
    "customData": {
      "foo": "bar"
    },
    "rects": [
      [
        100,
        200,
        300,
        400
      ]
    ],
    "outlineColor": "#ffffff",
    "overlayText": "CONFIDENTIAL",
    "color": "#ffffff",
    "note": "This is a note."
  }
}

Response

The redaction annotations have been added to the layer.

Example response

{
  "data": {
    "annotations": [
      {
        "content": {
          "bbox": [
            255.10077620466092,
            656.7566095695641,
            145.91672653256705,
            18.390804597701162
          ],
          "action": {
            "relativePath": "/other_document.pdf"
          },
          "id": "01DNEDPQQ22W49KDXRFPG4EPEQ",
          "createdAt": "2019-09-16T15:05:03.712909Z",
          "updatedAt": "2019-09-16T15:05:03.712909Z",
          "customData": {
            "foo": "bar"
          },
          "rects": [
            [
              100,
              200,
              300,
              400
            ]
          ],
          "color": "#fcee7c",
          "note": "This is a note."
        },
        "id": "01DNEDPQQ22W49KDXRFPG4EPEQ"
      }
    ]
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.