---
search:
  tags:
    - PII
    - POST
seo:
  description: >-
    Same detection as redaction but returns only the findings and a clean flag,
    for gating a… Reference for the POST /v1/pii/scan endpoint in the Webfold
    API.
sidebar:
  label: Check text for personal data
  badge: POST
title: Check text for personal data
type: openapi-operation
---
Same detection as redaction but returns only the findings and a `clean` flag, for gating a pipeline. The redacted text is not returned. Metered as `pii.scan`.

`POST /v1/pii/scan`

**Request body** (`application/json`, required)

- `text` (string, required) — Up to 1 MiB.

Request body example:

```json
{
  "text": "string"
}
```

**Responses**

- `200` — Findings
- `400` — Bad request
- `401` — Missing or invalid bearer token
- `403` — Billing or plan entitlement blocked the request
- `502` — Upstream service (arXiv, YouTube, web page) failed
- `503` — The backing service is not configured or is busy

Response example, 200:

```json
{
  "clean": true,
  "count": 0,
  "entity_types": [
    "string"
  ],
  "findings": [
    {
      "entity_type": "EMAIL",
      "start": 0,
      "end": 0,
      "score": 0
    }
  ]
}
```