---
title: "Redact Pdf"
method: POST
path: "/v1/pdf/redact"
tags: ["operations"]
---

# Redact Pdf

`POST /v1/pdf/redact`

## Request

- Base URL: `https://api.smartpdf.ru`
- URL: `https://api.smartpdf.ru/v1/pdf/redact`
- Auth: HTTP bearer

«Скрыть персональные данные» (change redact-pdf): области удаляются из файла, скрытые данные файла — тоже.

## Headers

- `X-API-Key` string, nullable

## Request body

- RedactRequest: Области (доли видимой страницы) удаляются и закрашиваются чёрным; find — ещё и найти персональные данные и скрыть их тем же запросом (API); clean — убрать скрытые данные файла. Нужно areas, find или оба.
  - `webhook_url` string, nullable: https-адрес для уведомления о завершении; подпись — заголовок X-SmartPDF-Signature (см. описание API)
  - `file_id` string, required
  - `areas` RedactArea[]
    - `page` integer, required
    - `box` number[], required
  - `find` PersonalDataSearchRequest: Что искать: виды номеров и свои слова (ФИО, адрес — каждое от 3 символов).
    - `kinds` string[]
    - `words` string[]
  - `clean` boolean

## Response `202`

Successful Response

- TaskIdResponse
  - `task_id` string, required

## Other responses

- `422`: Validation Error

---

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