Skip to main content

PII filter

The PII filter masks personally identifiable information with *. This feature requires an Enterprise license. Contact us via the Pricing page.

Supported PII types

  • Names
  • Addresses
  • Personal identifiers
    • Phone number
    • National ID
    • Passport number
    • Bank account number
    • Card number
    • Driver’s license number
    • Vehicle plate number

You can tune behavior via the pii_preset parameter:

  • all (default)
    • Preserve original text; mask only PII characters with *.
  • finance
    • Restore 8-digit non-birthdate numbers (e.g., verification codes)
    • Add hyphens to masked national IDs and phone numbers
    • Validate 15–16 digit card numbers; mask valid ones with hyphens, restore invalid ones

Usage

Set use_pii: true and choose a pii_preset.

In the POST Request body, set use_pii: true and choose pii_preset (e.g., all, finance).

POST example: Example

Unified example (presets): Example