Entity types¶
This page is generated from the PhiSQL spec artifacts for v1.0. Do not edit it by hand; change the artifact and rebuild.
Each entity type targets a category of PII. The Phileas field is the property the type compiles to in the redaction policy JSON.
| Entity type | Description | Phileas field |
|---|---|---|
AGE |
Age values (e.g., "35 years old", "age 42"). | age |
BANK_ROUTING_NUMBER |
Bank routing numbers. | bankRoutingNumber |
BITCOIN_ADDRESS |
Bitcoin wallet addresses. | bitcoinAddress |
CITY |
City names (dictionary matching). | city |
COUNTY |
County names (dictionary matching). | county |
CREDIT_CARD |
Credit card numbers. | creditCard |
CURRENCY |
Currency values (e.g., "$100.00", "50 EUR"). | currency |
DATE |
Date values in various formats. | date |
DRIVERS_LICENSE |
Driver's license numbers. | driversLicense |
EMAIL_ADDRESS |
Email addresses. | emailAddress |
FIRST_NAME |
Person first names (dictionary + fuzzy). | firstName |
HOSPITAL |
Hospital names. | hospital |
IBAN_CODE |
International Bank Account Numbers (IBAN). | ibanCode |
IP_ADDRESS |
IP addresses (IPv4 and IPv6). | ipAddress |
MAC_ADDRESS |
MAC addresses. | macAddress |
MEDICAL_CONDITION |
Medical conditions and diagnoses. | medicalCondition |
PASSPORT_NUMBER |
Passport numbers. | passportNumber |
PHONE_NUMBER |
Telephone numbers. | phoneNumber |
PHONE_NUMBER_EXTENSION |
Telephone number extensions. | phoneNumberExtension |
PHYSICIAN_NAME |
Physician names. | physicianName |
SSN |
U.S. Social Security Numbers. | ssn |
STATE |
U.S. state names. | state |
STATE_ABBREVIATION |
U.S. state abbreviations. | stateAbbreviation |
STREET_ADDRESS |
Street addresses. | streetAddress |
SURNAME |
Person surnames (dictionary + fuzzy). | surname |
TRACKING_NUMBER |
Package tracking numbers (UPS, FedEx, USPS, DHL). | trackingNumber |
URL |
URLs. | url |
VIN |
Vehicle Identification Numbers. | vin |
ZIP_CODE |
U.S. ZIP codes. | zipCode |
Custom identifiers¶
Custom identifiers are referenced with IDENTIFIER('<classification>') and compile to an entry under identifiers.identifiers[]. Define one with DEFINE IDENTIFIER.
Deferred to a later version¶
PERSON¶
The Phileas schema marks the person field deprecated ("use pheyes
instead"); it is a $ref to the same filterPhEye shape as the pheyes
array. PhiSQL exposes that shape fully through DETECT PHEYE, so person
detection is not lost — only the legacy person JSON key is unexposed.
Use DETECT PHEYE (or FIRST_NAME / SURNAME / PHYSICIAN_NAME) in PhiSQL v1.0.