Skip to main content
Version: Next

USTelephone Algorithm

This masker separates a US telephone number into four parts, the area code, the exchange, the subscriber number, and an optional extension. For example, the telephone number (603) 732-1234 x567 is composed of area code: 603, exchange: 732, subscriber number: 1234, and extension 567. The masker generates a new telephone number by replacing the exchange, number, and any extension with new digits. Area codes are left unchanged as they do not provide identifying information and may be useful for some statistical analysis. The subscriber number is always replaced by using a deterministic variable algorithm. The masker replaces the exchange and extension by using discrete values or using a deterministic variable algorithm to generate new values depending on the supplied properties.

Algorithm Characteristics

  • Algorithm: v
  • Masking Technique: Anonymization
  • Supported Types: String
  • Referential Integrity: false
  • Conflict-free: false
  • Realistic Data: true
  • Reversible: false

Properties

  • maskExchange { enum; optional; default: "DISCRETE" }
    One of DISCRETE, VARIABLE, or NONE. DISCRETE replaces the exchange portion of the number with the value of the exchangeDiscrete property. VARIABLE replaces the exchange using the value from a deterministic variable algorithm. NONE does not modify the exchange value.
    Example: "maskExchange": "VARIABLE"

  • exchangeDiscrete { string; optional; default: "555" }
    A three digit string used to replace the exchange number
    Example: "exchangeDiscrete": "555"

  • maskExtension { enum; optional; default: "NONE" }
    One of DISCRETE, VARIABLE, or NONE. DISCRETE replaces the extension portion of the number with the value of the extensionDiscrete property. VARIABLE replaces the extension using the value from a deterministic variable algorithm. NONE does not modify the extension value.
    Example: "maskExtension": "VARIABLE"

  • exchangeDiscrete { string; optional; default: "555" }
    A digit string used to replace the exchange number
    Example: "exchangeDiscrete": "1111"

Example JSON configuration

{
"name": "ExampleTelephoneMasker",
"description": "Sets the exchange to 555 and sets the subscriber number and optional exchance to a deterministic variable values.",
"algorithm": "USTelephone",
"maskExchange": "DISCRETE",
"exchangeDiscrete": "555",
"maskExtension": "VARIABLE",
}

Default Maskers based on the USTelephone Algorithm

  1. US555TelephoneMasker
  2. USExchangeTelephoneMasker