Zip Codes

Describes Philter's Zip Code filter.

Filter

This filter identifies zip codes in text.

Required Parameters

This filter has no required parameters.

Optional Parameters

Parameter

Description

Default Value

zipCodeFilterStrategies

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 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.

TRUNCATE

Replace the sensitive text by removing the last x digits. (Set the number of digits using the truncateDigits parameter of the filter strategy.)

ZERO_LEADING

Replace the sensitive text by zeroing the first 3 digits.

Conditions

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

Conditional

Description

Operators

TOKEN

Compares the value of the sensitive text.

== , !=

CONTEXT

Compares the filtering context.

== , !=

CONFIDENCE

Compares the confidence in the sensitive text against a threshold value.

< , <=, > , >=, ==, !=

POPULATION

Compares the population of the zip code against the 2010 census values.

< , <=, > , >=, ==, !=

Example Filter Profile

{
"name": "zip-code-example",
"identifiers": {
"zipCode": {
"zipCodeFilterStrategies": [
{
"strategy": "REDACT",
"redactionFormat": "{{{REDACTED-%t}}}"
}
]
}
}
}