# Address masking function

You can mask addresses. This function only applies on Strings.

| Function | Random masking | Consistent masking | Format-preserving encryption | Input data validation |
| --- | --- | --- | --- | --- |
| Address masking | Yes | No | No | No |

This function masks digits with other digits and other characters with X.

The following case-insensitive keywords will not be masked in the output: ALLEE, ALLEY, ALLÉE, AREA, AUFFAHRT, AV, AV., AVDA, AVE, AVE., AVENIDA, AVENUE, BACKROAD, BANLIEUE, BD, BD., BLV, BLV., BLVD, BOULEVARD, BREVE, BULEVAR, BVD, BVD., BYWAY, CALLE, CAMINHO, CAMINO, CARREFOUR, CARREGGIATA, CARRETERA, CHAUSSEE, CHAUSSÉE, CHEMIN, CITE, CITÉ, CORTO, COUR, COURT, CRT, CT, CT., CURTO, DR, DR., DRIVE, DRIVEWAY, ESD, ESPLANADA, ESPLANADE, ESTRADA, FAUBOURG, FORUM, FREEWAY, GLEIS, HIGHWAY, HWY, IMPASSE, INDUSTRIAL, INDUSTRIALE, INDUSTRIELLE, KURZ, LANE, LUNGOMARE, MANEIRA, MODO, PARKWAY, PARVIS, PASSAGE, PASSERELLE, PERIFERIA, PERIFERICO, PERIFÉRICO, PERIPHERAL, PERIPHERIQUE, PIAZZA, PISTA, PL, PL., PLACE, PLATZ, PLAZA, PONT, PORTE, PROMENADE, PERIPHERIQUE, PÉRIPHÉRIQUE, QUADRADO, QUAI, R, R., RD, RD., ROAD, ROUTE, RTE, RUA, RUE, SQUARE, ST, ST., STD, STR, STRADA, STRASSE, STREET, SUBURB, SUBURBIO, SUBÚRBIO, TERRASSE, TRACK, UBER, VIA, VIALE, VILLA, VLE, VOIE, VORORT, VÍA, WAY, WEG, ZONA, ZONE, ÁREA, ÜBER.

Information noteNote: This list is not exhaustive.

| Option | Description |
| --- | --- |
| Extra parameter | The optional extra parameter can be:<br><br><ul> <li>a comma-separated list of two key words minimum</li> <li>a path to a file containing keywords</li> </ul><br><br>Those keywords are added to the default list and will not be masked in<br>the output |

In the first example, the extra parameter is not set. The word "venelle" is not part of the list of keywords. As a result, this word is masked in the output.

In the second example, "venelle" is added to the list of keywords. As a result, this word is not masked in the output.

| Input value | Extra parameter | Example of a masked value |
| --- | --- | --- |
| 3 venelle Artémis | "" | 5 XXXXXXX XXXXXXX |
| 3 venelle Artémis | "venelle,enceinte" | 6 venelle XXXXXXX |