v1

latestOpenAPI 3.0.3Commercial2026-07-1312828.4 KB
Content

PII redaction

Detects and redacts personally identifiable information (PII) from text. Supports names, email addresses, phone numbers, UK postcodes, NHS numbers, and credit card numbers.

post/redact

Request body

textstring required

Text to redact

redactstring

Comma-separated PII types to redact. Omit for all types.

entitiesboolean

Include detected entity positions in response

Example request

{
  "text": "Call John on 07911 123456 or email john@example.com",
  "redact": "phone,email"
}

Response

Redacted text

original_lengthinteger
redactedstring
countsobject

Example response

{
  "counts": {
    "phone": 1,
    "email": 2
  },
  "entities": [
    {
      "type": "phone"
    }
  ]
}