Skip to Content
Entity Types

Entity Types

Expunct detects and redacts 27+ entity types organized into three categories: PII, PCI, and PHI. Each entity type has a unique identifier used in API requests and responses.

PII — Personally Identifiable Information

21 entity types for general personal data.

Entity TypeDescriptionExample
PERSONFull name of an individualJohn Smith
EMAIL_ADDRESSEmail addressjohn@example.com
PHONE_NUMBERPhone number (various formats)+1 (555) 123-4567
LOCATIONGeographic location or regionNew York, California
ADDRESSPhysical street address123 Main St, Apt 4B, New York, NY 10001
DATE_OF_BIRTHDate of birth01/15/1990
DATE_TIMEDate and/or time referenceMarch 15, 2024 at 3:00 PM
AGEAge of a person34 years old
NATIONALITYNational origin or citizenshipAmerican, British
IP_ADDRESSIPv4 or IPv6 address192.168.1.1
URLWeb URLhttps://example.com/path 
US_SSNUS Social Security Number123-45-6789
US_DRIVER_LICENSEUS driver’s license numberD1234567
US_PASSPORTUS passport number912345678
US_ITINUS Individual Taxpayer Identification Number900-70-0000
UK_NHSUK National Health Service number943 476 5919
AU_TFNAustralian Tax File Number123 456 782
AU_MEDICAREAustralian Medicare number2123 45670 1
SG_NRIC_FINSingapore National Registration Identity Card / Foreign Identification NumberS1234567D
IN_AADHAARIndian Aadhaar number2345 6789 0123
IN_PANIndian Permanent Account NumberABCDE1234F

PCI — Payment Card Industry

4 entity types for financial data.

Entity TypeDescriptionExample
CREDIT_CARDCredit or debit card number4111 1111 1111 1111
US_BANK_NUMBERUS bank account number1234567890
IBAN_CODEInternational Bank Account NumberGB29 NWBK 6016 1331 9268 19
CRYPTOCryptocurrency wallet address1A1zP1eP5QGefi2DMPTfTL5SLmv7DivfNa

PHI — Protected Health Information

2 entity types for health and sensitive group data.

Entity TypeDescriptionExample
MEDICAL_LICENSEMedical license numberMD12345
NRPNationality, Religious, or Political groupDemocratic Party, Buddhist

Using entity types in API requests

You can specify which entity types to detect by passing an entities list in your request. If omitted, all entity types are detected by default.

{ "text": "John Smith's SSN is 123-45-6789", "entities": ["PERSON", "US_SSN"] }

You can also configure per-entity actions (redact, mask, pseudonymize, or allow) using policies.

Per-category actions

Policies support configuring actions at the category level:

ActionBehaviorExample output
redactReplace with entity type label[PERSON]
maskReplace characters with asterisks**** *****
pseudonymizeReplace with consistent fake valueRobert Johnson
allowLeave the text unchangedJohn Smith

See the Workflows page for detailed examples.