Passport Numbers

Filter

This filter identifies US passport numbers in text.

Required Parameters

This filter has no required parameters.

Optional Parameters

Parameter	Description	Default Value
`passportNumberFilterStrategies`	A list of filter strategies.	None
`enabled`	When set to false, the filter will be disabled and not applied	`true`
`ignored`	A list of terms to be ignored by the filter.	None

Filter Strategies

The filter may have zero or more filter strategies. When no filter strategy is given the default strategy of REDACT is used. When multiple filter strategies are given the filter strategies will be applied in order as they are listed. See Filter Strategies for details.

Strategy	Description
`REDACT`	Replace the sensitive text with a placeholder.
`RANDOM_REPLACE`	Replace the sensitive text with a similar, random value.
`STATIC_REPLACE`	Replace the sensitive text with a given value.
`CRYPTO_REPLACE`	Replace the sensitive text with its encrypted value.
`HASH_SHA256_REPLACE`	Replace the sensitive text with its SHA256 hash value.
`FPE_ENCRYPT_REPLACE`	Replace the sensitive text with a value generated by format-preserving encryption (FPE)

Conditions

Each filter strategy may have one condition. See Conditions for details.

Conditional	Description	Operators
`TOKEN`	Compares the value of the sensitive text.	`==`, `!=`
`CLASSIFICATION`	Compares the issuing country of the passport number.	`==`, `!=`
`CONTEXT`	Compares the filtering context.	`==`, `!=`
`CONFIDENCE`	Compares the confidence in the sensitive text against a threshold value.	`<`, `<=`, `>`, `>=`, `==`, `!=`

Example Policy

{
   "name": "passport-number-example",
   "identifiers": {
      "passportNumber": {
         "passportNumberFilterStrategies": [
            {
               "strategy": "REDACT",
               "redactionFormat": "{{{REDACTED-%t}}}"
            }
         ]
      }
   }
}

Last modified: 17 November 2023