---
title: "Scan text for personally identifiable information (PII/PHI/PCI) before passing it to an LLM or storing it."
method: POST
path: "/v1/scan/pii"
tags: ["security"]
---

# Scan text for personally identifiable information (PII/PHI/PCI) before passing it to an LLM or storing it.

`POST /v1/scan/pii`

## Request

- Base URL: `https://api.agent-toolbox.ai`
- URL: `https://api.agent-toolbox.ai/v1/scan/pii`
- Auth: one of:
  - HTTP bearer
  - none

Cost: 1 credit(s). Free tier: 10 calls per IP (no auth).

## Request body

- ScanPiiRequest
  - `text` string, required
  - `filename` string
  - `policy` object
    - `mode` 'block' | 'flag' | 'audit'
    - `blockSeverityAtOrAbove` 'low' | 'medium' | 'high' | 'critical'
    - `allowTypes` string[]
    - `jurisdictions` string[]
    - `redact` boolean

## Response `200`

Success.

- ScanPiiResponse
  - `verdict` 'PASS' | 'FLAG' | 'BLOCK', required
  - `safe` boolean, required
  - `score` number, required
  - `categories` string[], required
  - `totalFindings` integer, required
  - `counts` object, required
    - `low` integer
    - `medium` integer
    - `high` integer
    - `critical` integer
  - `entities` object[], required
    - `type` string, required
    - `category` 'PII' | 'PHI' | 'PCI', required
    - `severity` 'low' | 'medium' | 'high' | 'critical', required
    - `match` string, required
    - `start` integer, required
    - `end` integer, required
    - `line` integer, required
    - `validated` boolean, required
    - `confidence` number, required
    - `jurisdiction` string
  - `redactedText` string
  - `certificate` string, required: Tamper-evident SHA-256 certificate.
  - `enforcementMode` 'block' | 'flag' | 'audit', required
  - `filename` string
  - `latencyMs` number, required: Server compute time in ms.

## Other responses

- `400`: Invalid request body.
- `402`: Free tier exhausted or insufficient credits.

---

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