Skip to content

What it detects ​

pii-airlock combines Microsoft Presidio, a language model for names, and its own checked recognizers. Use these type names with pii-airlock action.

Common types ​

TypeExamples
PERSONNames
EMAIL_ADDRESSjean@acme.fr
PHONE_NUMBER+33 6 12 34 56 78, 079 123 45 67
CREDIT_CARDCard numbers
IBAN_CODEBank account numbers
IP_ADDRESS192.168.1.10
LOCATIONCities, addresses
SECRETAPI keys, tokens, private keys, password=… values

Extra recognizers that work in any language ​

These check the number's built-in check digit, so a random number does not trigger them.

TypeWhat it is
FR_NIRFrench social security number
CH_AHVSwiss AHV/AVS number
FR_SIRET, FR_SIRENFrench business IDs
DE_TAX_IDGerman tax ID (needs a nearby keyword such as Steuer-ID)
DE_TAX_NUMBERGerman Steuernummer (needs a keyword)
IT_VAT_CODEItalian VAT number
SECRETKeys for AWS, GitHub, Slack, OpenAI, Anthropic, Google and Stripe, plus JWTs

Ignored by default ​

These fire on almost every date and web link, so they are off unless you ask:

DATE_TIME, URL, NRP, US_DRIVER_LICENSE, US_BANK_NUMBER, US_PASSPORT, IN_VEHICLE_REGISTRATION

An email or name inside a link is still caught by its own recognizer.

To turn one on, set exclude_entities to a list without it, or an action for that type. To turn off all the extra recognizers: builtin_recognizers: false.

Released under the MIT License.