---
title: "Create redaction preview link (integrators)"
method: POST
path: "/document_delivery/create_redact_preview_link"
tags: ["Document AI — Anonymization"]
---

# Create redaction preview link (integrators)

`POST /document_delivery/create_redact_preview_link`

## Request

- Base URL: `https://api.paperoffice.ai/latest`
- URL: `https://api.paperoffice.ai/latest/document_delivery/create_redact_preview_link`
- Auth: HTTP bearer

POST /document_delivery/create_redact_preview_link (JSON or form, Bearer). Params: preview_job_id (required, finished document_anonymize_preview job of this account), ttl_sec (300–604800, default 86400), allow_finalize (default true)...

## Response `200`

Success

- object: PII detection preview (without redaction)
  - `status` 'success' | 'error', required: HTTP-Level Status
  - `job_id` string, required
  - `message` string: Human-readable status message
  - `pipeline` string: Name of the executed pipeline
  - `operation` string: Executed operation
  - `processing_time` string: Total processing time including queue (format: 123.45ms)
  - `result` object, required: The actual processing result
    - `status` 'completed' | 'failed' | 'timeout': Job-Level Status
    - `message` string: Pipeline-specific status message
    - `duration_ms` string: Pure pipeline processing time in ms
    - `output` object
      - `pii_found` boolean: Whether PII data was found
      - `pii_count` number: Number of PII matches found
      - `pii_details` object[]: Details for each PII match
        - `type` string: PII type (name, email, phone, iban, etc.)
        - `value` string: Gefundener Wert
        - `page` number
        - `position` object
        - `confidence` number

## Other responses

- `4XX`: Error
- `5XX`: Error

---

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