Skip to main content

Supported Entities

Use pii_entities to control which categories Guardian Layer transforms or redacts.

By default, Guardian Layer targets all detected sensitive content. You only need pii_entities when you want to limit processing to specific categories.

Entity Reference​

EntityWhat it coversExample
PERSONPeople names and name-like references.Dana Reyes, Dr. Emily Chen
PHONE_NUMBERPhone numbers.555-0100, +1 415 555 0123
EMAIL_ADDRESSEmail addresses.alex@example.com
LOCATIONAddresses, cities, regions, and location-like references.123 Market Street, Auckland
DATE_TIMEDates and time references.March 3, 2026-06-04
ID_NUMBERAccount numbers, IDs, document numbers, and similar identifiers.ACCT-8842, ID 123456
AGEAge expressions.45 years old, aged 67
ALLAll supported entity categories.Use when you do not want to filter.

Text Requests​

For text endpoints, pass pii_entities as a JSON list:

{
  "text": "Dr. Emily Chen called Alex at 555-0100.",
  "domain": "General",
  "masking_type": "redact",
  "pii_entities": ["PERSON", "PHONE_NUMBER"]
}

This tells Guardian Layer to focus on names and phone numbers.

To process all detected sensitive content, omit pii_entities or pass:

{
  "pii_entities": ["ALL"]
}

File Requests​

For file upload endpoints, pass pii_entities as a comma-separated form field:

PERSON,PHONE_NUMBER

To process all entities in a file request, leave the field empty or pass:

ALL

Notes​

  • Entity filtering applies to both transform and redact.
  • File form values are normalized to uppercase by the API.
  • LOCATION may include addresses, streets, cities, regions, and other location-like values detected by the underlying detector.
  • ID_NUMBER may include account-like values and document-style identifiers.
  • Passing null, an empty list, or ["ALL"] means all detected sensitive content is eligible for processing.

Next Steps​