---
title: "Redact areas of a document"
method: POST
path: "/documents/{document_id}/redact"
tags: ["document"]
---

# Redact areas of a document

`POST /documents/{document_id}/redact`

## Request

- Base URL: `https://localhost:4410/api/v1`
- URL: `https://localhost:4410/api/v1/documents/{document_id}/redact`
- Auth: HTTP bearer

Makes a new version of the document with the text, images and drawings under each area removed and a black box in its place, and each page with an area flattened, so nothing under a box survives. Links and data rooms show the new version; the original stays as an earlier version, which only the company's members open.

## Path parameters

- `document_id` string, required

## Request body

- object
  - `version` integer, required
  - `areas` object[], required
    - `page` integer, required
    - `x` number, required
    - `y` number, required
    - `width` number, required
    - `height` number, required

## Response `200`

The result.

- object
  - `document_id` string, required
  - `version` integer, required
  - `pages` integer, required

## Other responses

- `202`: Called by an agent or an API key, so the call did not run. A person approves it at approval_url; then GET the Location.
- `default`: An RFC 9457 problem.

---

[API](https://skmtc.dev/binderwork/apis/binderwork-api.md) · [All operations](https://skmtc.dev/binderwork/apis/binderwork-api/llms.txt) · [OpenAPI document](https://skmtc.dev/binderwork/apis/binderwork-api/revisions/f8fab0ebee53?raw)