---
title: "Suggest redactions for a document"
method: POST
path: "/documents/{document_id}/redactions/suggest"
tags: ["document"]
---

# Suggest redactions for a document

`POST /documents/{document_id}/redactions/suggest`

## Request

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

Areas of the document's current version that hold personal data, each with its reason: the rules' SSNs, card numbers, IBANs, routing numbers and EINs, and, when an owner turned on checking files with AI and a decision model is set up, spans the model reads as an individual's salary, date of birth or home address, with a band. Nothing is redacted until a person applies them with document.redact.

## Path parameters

- `document_id` string, required

## Request body

- object

## Response `200`

The result.

- object
  - `version` integer, required
  - `suggestions` object[], required
    - `key` string, required
    - `page` integer, required
    - `reason` string, required
    - `band` 'high' | 'medium' | 'low', nullable, required
    - `boxes` object[], required
      - `page` integer, required
      - `x` number, required
      - `y` number, required
      - `width` number, required
      - `height` number, required
  - `skipped` string[], required

## Other responses

- `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)