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 Type | Description | Example |
|---|---|---|
PERSON | Full name of an individual | John Smith |
EMAIL_ADDRESS | Email address | john@example.com |
PHONE_NUMBER | Phone number (various formats) | +1 (555) 123-4567 |
LOCATION | Geographic location or region | New York, California |
ADDRESS | Physical street address | 123 Main St, Apt 4B, New York, NY 10001 |
DATE_OF_BIRTH | Date of birth | 01/15/1990 |
DATE_TIME | Date and/or time reference | March 15, 2024 at 3:00 PM |
AGE | Age of a person | 34 years old |
NATIONALITY | National origin or citizenship | American, British |
IP_ADDRESS | IPv4 or IPv6 address | 192.168.1.1 |
URL | Web URL | https://example.com/path |
US_SSN | US Social Security Number | 123-45-6789 |
US_DRIVER_LICENSE | US driver’s license number | D1234567 |
US_PASSPORT | US passport number | 912345678 |
US_ITIN | US Individual Taxpayer Identification Number | 900-70-0000 |
UK_NHS | UK National Health Service number | 943 476 5919 |
AU_TFN | Australian Tax File Number | 123 456 782 |
AU_MEDICARE | Australian Medicare number | 2123 45670 1 |
SG_NRIC_FIN | Singapore National Registration Identity Card / Foreign Identification Number | S1234567D |
IN_AADHAAR | Indian Aadhaar number | 2345 6789 0123 |
IN_PAN | Indian Permanent Account Number | ABCDE1234F |
PCI — Payment Card Industry
4 entity types for financial data.
| Entity Type | Description | Example |
|---|---|---|
CREDIT_CARD | Credit or debit card number | 4111 1111 1111 1111 |
US_BANK_NUMBER | US bank account number | 1234567890 |
IBAN_CODE | International Bank Account Number | GB29 NWBK 6016 1331 9268 19 |
CRYPTO | Cryptocurrency wallet address | 1A1zP1eP5QGefi2DMPTfTL5SLmv7DivfNa |
PHI — Protected Health Information
2 entity types for health and sensitive group data.
| Entity Type | Description | Example |
|---|---|---|
MEDICAL_LICENSE | Medical license number | MD12345 |
NRP | Nationality, Religious, or Political group | Democratic 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:
| Action | Behavior | Example output |
|---|---|---|
redact | Replace with entity type label | [PERSON] |
mask | Replace characters with asterisks | **** ***** |
pseudonymize | Replace with consistent fake value | Robert Johnson |
allow | Leave the text unchanged | John Smith |
See the Workflows page for detailed examples.