---
title: "Scan Text"
method: POST
path: "/v1/admin/pii/scan"
tags: ["pii"]
---

# Scan Text

`POST /v1/admin/pii/scan`

## Request

- Base URL: `https://api.storyflo.com` (the document declares no server; this is the origin it was published from)
- URL: `https://api.storyflo.com/v1/admin/pii/scan`
- Auth: none declared

## Headers

- `x-storyflo-email-token` string, nullable

## Request body

- ScanBody
  - `text` string, required
  - `scrub` boolean: If true, also return the scrubbed text

## Response `200`

Successful Response

- ScanResponse
  - `total` integer, required
  - `hard` integer, required
  - `soft` integer, required
  - `by_category` object, required
  - `hits` ScanHit[], required
    - `category` string, required
    - `severity` string, required
    - `pattern_name` string, required
    - `sample` string, required
    - `start` integer, required
    - `end` integer, required
  - `scrubbed_text` string, nullable

## Other responses

- `422`: Validation Error

---

[API](https://skmtc.dev/storyflo/apis/storyflo-inference-router.md) · [All operations](https://skmtc.dev/storyflo/apis/storyflo-inference-router/llms.txt) · [OpenAPI document](https://skmtc.dev/storyflo/apis/storyflo-inference-router/revisions/c3a1a735ac7a?raw)