# Phone masking functions
You can mask French, German, Japanese, UK, and US phone numbers.
| Function | Random masking | Consistent masking | Format-preserving encryption | Input data validation |
| --- | --- | --- | --- | --- |
| Mask French phone number | No | No | Yes | Yes |
| Mask German phone number | No | No | Yes | Yes |
| Mask Japanese phone number | No | No | Yes | Yes |
| Mask UK phone number | No | No | Yes | Yes |
| Mask US phone number | No | No | Yes | Yes |
## Mask French phone number
This function generates a unique random French phone number related to the input.
This function masks the last six digits. Input values that contain at least six digits are regarded as valid phone numbers.
When the input value is not valid, the function returns null.
This function only applies on Strings.
If there are duplicates in the input data, you will get the same duplicates in the masked values. In the same way, if there are no duplicates in the input data, there will be no duplicates in the masked values.
| Option | Description |
| --- | --- |
| Method | The default Basic method uses a proprietary
algorithm.
Information noteNote: As the masking methods are stronger, it is recommended to use the FF1
algorithms rather than the Basic method.
This function can encrypt the output masked
values in the same format as the input values, using Format-Preserving Encryption (FPE)
methods:
- FF1 with AES relies on the Advanced Encryption Standard in CBC mode.
- FF1 with SHA-2 relies on the secure hash function HMAC-256.
The FPE methods are bijective methods, except when
using tweaks.
The FF1 with
AES and FF1 with SHA-2 methods
require a password to generate encrypted and repeatable masked values. Those FPE methods
do not use a seed.
You can specify this password in the Password or
256-bit key for FF1 methods field, from the Advanced
Settings of the component. |
| Extra parameter | This function requires no extra
parameter. |
In the following example, the Keep format check box is selected to preserve the spaces from the input value.
| Input value | Method | Example of masked value |
| --- | --- | --- |
| 02 40 99 90 99 | FF1 with AES | 02 40 89 78 01 |
## Mask German phone number
This function generates a unique random German phone number related to the input.
This function masks the last eight digits. Input values that contain at least eight digits are regarded as valid phone numbers.
When the input value is not valid, the function returns null.
This function only applies on Strings.
If there are duplicates in the input data, you will get the same duplicates in the masked values. In the same way, if there are no duplicates in the input data, there will be no duplicates in the masked values.
| Option | Description |
| --- | --- |
| Method | The default Basic method uses a proprietary
algorithm.
Information noteNote: As the masking methods are stronger, it is recommended to use the FF1
algorithms rather than the Basic method.
This function can encrypt the output masked
values in the same format as the input values, using Format-Preserving Encryption (FPE)
methods:
- FF1 with AES relies on the Advanced Encryption Standard in CBC mode.
- FF1 with SHA-2 relies on the secure hash function HMAC-256.
The FPE methods are bijective methods, except when
using tweaks.
The FF1 with
AES and FF1 with SHA-2 methods
require a password to generate encrypted and repeatable masked values. Those FPE methods
do not use a seed.
You can specify this password in the Password or
256-bit key for FF1 methods field, from the Advanced
Settings of the component. |
| Extra parameter | This function requires no extra
parameter. |
In the following example, the Keep format check box is selected to preserve the dash from the input value.
| Input value | Method | Example of masked value |
| --- | --- | --- |
| 636-48018 | FF1 with AES | 389-54922 |
## Mask Japanese phone number
This function generates a unique random Japanese phone number related to the input.
This function masks the last seven digits. Input values that contain at least seven digits are regarded as valid phone numbers.
When the input value is not valid, the function returns null.
This function only applies on Strings.
If there are duplicates in the input data, you will get the same duplicates in the masked values. In the same way, if there are no duplicates in the input data, there will be no duplicates in the masked values.
| Option | Description |
| --- | --- |
| Method | The default Basic method uses a proprietary
algorithm.
Information noteNote: As the masking methods are stronger, it is recommended to use the FF1
algorithms rather than the Basic method.
This function can encrypt the output masked
values in the same format as the input values, using Format-Preserving Encryption (FPE)
methods:
- FF1 with AES relies on the Advanced Encryption Standard in CBC mode.
- FF1 with SHA-2 relies on the secure hash function HMAC-256.
The FPE methods are bijective methods, except when
using tweaks.
The FF1 with
AES and FF1 with SHA-2 methods
require a password to generate encrypted and repeatable masked values. Those FPE methods
do not use a seed.
You can specify this password in the Password or
256-bit key for FF1 methods field, from the Advanced
Settings of the component. |
| Extra parameter | This function requires no extra
parameter. |
In the following example, the Keep format check box is selected to preserve the dashes from the input value.
| Input value | Method | Example of masked value |
| --- | --- | --- |
| 052-2451-4455 | FF1 with AES | 052-2970-7735 |
## Mask UK phone number
This function generates a unique random UK phone number related to the input.
This function masks the last seven digits. Input values that contain at least seven digits are regarded as valid phone numbers.
When the input value is not valid, the function returns null.
This function only applies on Strings.
If there are duplicates in the input data, you will get the same duplicates in the masked values. In the same way, if there are no duplicates in the input data, there will be no duplicates in the masked values.
| Option | Description |
| --- | --- |
| Method | The default Basic method uses a proprietary
algorithm.
Information noteNote: As the masking methods are stronger, it is recommended to use the FF1
algorithms rather than the Basic method.
This function can encrypt the output masked
values in the same format as the input values, using Format-Preserving Encryption (FPE)
methods:
- FF1 with AES relies on the Advanced Encryption Standard in CBC mode.
- FF1 with SHA-2 relies on the secure hash function HMAC-256.
The FPE methods are bijective methods, except when
using tweaks.
The FF1 with
AES and FF1 with SHA-2 methods
require a password to generate encrypted and repeatable masked values. Those FPE methods
do not use a seed.
You can specify this password in the Password or
256-bit key for FF1 methods field, from the Advanced
Settings of the component. |
| Extra parameter | This function requires no extra
parameter. |
| Input value | Method | Example of masked value |
| --- | --- | --- |
| 02071231234 | FF1 with AES | 02074444306 |
## Mask US phone number
This function generates a unique random US phone number related to the input.
This function masks the last six digits. Input values that contain at least six digits are regarded as valid phone numbers.
When the input value is not valid, the function returns null.
This function only applies on Strings.
If there are duplicates in the input data, you will get the same duplicates in the masked values. In the same way, if there are no duplicates in the input data, there will be no duplicates in the masked values.
| Option | Description |
| --- | --- |
| Method | The default Basic method uses a proprietary
algorithm.
Information noteNote: As the masking methods are stronger, it is recommended to use the FF1
algorithms rather than the Basic method.
This function can encrypt the output masked
values in the same format as the input values, using Format-Preserving Encryption (FPE)
methods:
- FF1 with AES relies on the Advanced Encryption Standard in CBC mode.
- FF1 with SHA-2 relies on the secure hash function HMAC-256.
The FPE methods are bijective methods, except when
using tweaks.
The FF1 with
AES and FF1 with SHA-2 methods
require a password to generate encrypted and repeatable masked values. Those FPE methods
do not use a seed.
You can specify this password in the Password or
256-bit key for FF1 methods field, from the Advanced
Settings of the component. |
| Extra parameter | This function requires no extra
parameter. |
In the following example, the Keep format check box is selected to preserve the dash from the input value.
| Input value | Method | Example of masked value |
| --- | --- | --- |
| 636-48018 | FF1 with AES | 389-54922 |