pii-mask

Detectors Reference

Complete table of all built-in PII detectors.

All detectors

IDLabelCategoryRegionsDescription
emailEmail Addresscontact—RFC 5322 email addresses
phone-globalPhone Numbercontact—International phone numbers via libphonenumber-js (20+ country local formats)
credit-cardCredit Cardfinancial—Card numbers in a real issuer range, Luhn-validated
ibanIBANfinancial—IBANs (mod-97), compact or printed in groups
ssn-usSSN (US)gov-idUSUS Social Security Numbers
nin-ngNIN (NG)gov-idNGNigerian National ID Numbers (needs a nin key or context)
bvn-ngBVN (NG)gov-idNGNigerian Bank Verification Numbers (needs a bvn key or context)
aadhaar-inAadhaar (IN)gov-idINAadhaar numbers: grouped 2341 2341 2346, or bare with an aadhaar key
pan-inPAN (IN)gov-idINIndian PAN numbers
said-zaSA ID (ZA)gov-idZASouth African ID numbers
nin-ukNIN (UK)gov-idGBUK National Insurance Numbers (regions: ['GB']; UK also accepted)
nik-idNIK (ID)gov-idIDIndonesian NIK numbers
cpf-brCPF (BR)gov-idBRBrazilian CPF numbers
passportPassport Numbergov-id—Passport numbers
sin-caSIN (CA)gov-idCACanadian Social Insurance Numbers
ip-addressIP Addressnetwork—IPv4 addresses
ipv6IPv6 Addressnetwork—IPv6 addresses, including compressed forms
mac-addressMAC Addressnetwork—Hardware MAC addresses
dobDate of Birthbiometric—Dates of birth — needs a birth key (dob …) or context word (born)
person-namePerson Nameidentity—Person names via key heuristics
addressAddressidentity—Physical addresses via key heuristics
uuidUUIDidentity—UUID v1–v5 identifiers
mongodb-objectidMongoDB ObjectIdidentity—24-character hex MongoDB ObjectIds
vinVINidentity—Vehicle Identification Numbers (17-char)
secret-keySecret / API Keysecret—Passwords, tokens, API keys, cookies, Authorization via key heuristics
jwtJWTsecret—JSON Web Tokens
bcrypt-hashbcrypt Hashsecret—bcrypt password hashes
hex-secretHex Secretsecret—32/64-char hex strings (not under trace-ID, checksum or commit keys)
aws-keyAWS Access Keysecret—AWS access key IDs (AKIA/ASIA prefix)
github-patGitHub PATsecret—GitHub personal access tokens (ghp_, gho_, ghs_, etc.)
platform-tokenPlatform Tokensecret—Slack (xox*) and Stripe (sk_/rk_) tokens

On this page