pii-mask

Detectors Reference

Complete table of all built-in PII detectors.

All detectors

IDLabelCategoryRegionsDescription
emailEmail AddresscontactRFC 5322 email addresses
phonePhone NumbercontactInternational phone numbers via libphonenumber-js (20+ country local formats)
credit-cardCredit CardfinancialLuhn-validated card numbers
ibanIBANfinancialInternational bank account numbers
ssn-usSSN (US)gov-idUSUS Social Security Numbers
nin-ngNIN (NG)gov-idNGNigerian National ID Numbers
bvn-ngBVN (NG)gov-idNGNigerian Bank Verification Numbers
aadhaar-inAadhaar (IN)gov-idINIndian Aadhaar numbers
pan-inPAN (IN)gov-idINIndian PAN numbers
said-zaSA ID (ZA)gov-idZASouth African ID numbers
nin-ukNIN (UK)gov-idGBUK National Insurance Numbers
nik-idNIK (ID)gov-idIDIndonesian NIK numbers
cpf-brCPF (BR)gov-idBRBrazilian CPF numbers
passportPassport Numbergov-idPassport numbers
sin-caSIN (CA)gov-idCACanadian Social Insurance Numbers
ip-addressIP AddressnetworkIPv4 addresses
ipv6IPv6 AddressnetworkIPv6 addresses
mac-addressMAC AddressnetworkHardware MAC addresses
dobDate of BirthbiometricDate of birth fields (ISO 8601 and common formats)
person-namePerson NameidentityPerson names via key heuristics
addressAddressidentityPhysical addresses via key heuristics
uuidUUIDidentityUUID v1–v5 identifiers
mongodb-objectidMongoDB ObjectIdidentity24-character hex MongoDB ObjectIds
vinVINidentityVehicle Identification Numbers (17-char)
secret-keySecret / API KeysecretAPI keys, tokens, passwords via key heuristics
jwtJWTsecretJSON Web Tokens
bcrypt-hashbcrypt Hashsecretbcrypt password hashes
hex-secretHex SecretsecretLong hex strings (32+ characters)
aws-keyAWS Access KeysecretAWS access key IDs (AKIA/ASIA prefix)
github-patGitHub PATsecretGitHub personal access tokens (ghp_, gho_, ghs_, etc.)
platform-tokenPlatform TokensecretSlack (xox*) and Stripe (sk_/rk_) tokens

On this page