Skip to main content

Module pii

Module pii 

Source
Expand description

PII detection.

Detects personally identifiable information in content.

Structsยง

PiiDetector
Detector for personally identifiable information.
PiiMatch
A detected PII match.
PiiPattern ๐Ÿ”’
Pattern for detecting PII.

Staticsยง

AU_TFN_REGEX ๐Ÿ”’
Australian Tax File Number (TFN): 8-9 digits
CA_SIN_REGEX ๐Ÿ”’
Canada Social Insurance Number: 9 digits, often XXX-XXX-XXX or XXX XXX XXX
CREDIT_CARD_REGEX ๐Ÿ”’
DL_REGEX ๐Ÿ”’
DOB_REGEX ๐Ÿ”’
EMAIL_REGEX ๐Ÿ”’
EU_VAT_REGEX ๐Ÿ”’
EU VAT Number: Country prefix (2 letters) + country-specific format Common formats: AT + U + 8 digits, BE + 10 digits, DE + 9 digits, etc.
IN_AADHAAR_REGEX ๐Ÿ”’
Indian Aadhaar Number: 12 digits, often formatted as XXXX XXXX XXXX
IN_PAN_REGEX ๐Ÿ”’
Indian PAN (Permanent Account Number): 5 letters + 4 digits + 1 letter
IP_REGEX ๐Ÿ”’
PASSPORT_REGEX ๐Ÿ”’
PHONE_REGEX ๐Ÿ”’
SSN_REGEX ๐Ÿ”’
UK_NIN_REGEX ๐Ÿ”’
UK National Insurance Number: 2 letters + 6 digits + 1 letter (e.g., AB123456C) Letters may be separated by spaces or dashes
ZIP_REGEX ๐Ÿ”’

Functionsยง

deduplicate_overlapping ๐Ÿ”’
Removes overlapping matches, keeping the first occurrence.
is_local_ip ๐Ÿ”’
Checks if an IP address is a local/private address.
is_zip_in_address_context ๐Ÿ”’
Checks if a ZIP code appears in an address context.
pii_patterns ๐Ÿ”’
Returns the list of PII patterns to check.