Skip to main content

Supported PII Entities

Use this page as a quick reference for values accepted by pii_entities.

For conceptual guidance, see Guardian Layer: Supported Entities.

Entity Values

EntityDescriptionExample
PERSONPeople names and name-like references.Dana Reyes
PHONE_NUMBERPhone numbers.+1 415 555 0123
EMAIL_ADDRESSEmail addresses.alex@example.com
LOCATIONAddresses, cities, regions, and location-like references.123 Market Street
DATE_TIMEDates and time references.2026-06-12
ID_NUMBERAccount numbers, document IDs, SSNs, and similar identifiers.ACCT-8842
AGEAge expressions.45 years old
ALLAll supported entity categories.Use when you do not want to filter.

Text Request Format

For JSON text endpoints, pass an array:

{
"pii_entities": ["PERSON", "EMAIL_ADDRESS", "PHONE_NUMBER"]
}

To process all supported entities:

{
"pii_entities": ["ALL"]
}

You can also omit pii_entities to process all detected sensitive content.

File Request Format

For file upload endpoints, pass a comma-separated form value:

PERSON,EMAIL_ADDRESS,PHONE_NUMBER

To process all supported entities:

ALL