Skip to main content
Skip table of contents


Based > Extensible Algorithm Framework

The First Name algorithm is an instance of the Name Algorithm Framework. The algorithm requires String type input values.

The expected format for the valid input contains at least one word, which consist of at least one non-whitespace character. If the input value does not match the expected format, the value will not be masked. I.e. if input contains null or empty string or white spaces only, then the algorithm returns unmasked input value.

No non-conformant data errors are thrown by that algorithm.

Single character is considered an abbreviation, i.e. it will be masked to a single character. Whether it is followed by the dot (.) or not. Words separated by the hyphen (-) are considered as a single word (even if divided from hyphen by spaces).

The default First Name instance is configured without particle files, so every input word is considered as a valid part of the name. The maximum number of names masked and returned is 2; additional names are dropped. Leading and trailing white spaces are not preserved.

For example:


Masked Output



"" (empty string)


" " (white spaces only)

" "

& (single non alphanumeric character)








Ann- Marie


Ann-Marie M.

Boris S.

Ann-Marie Jane Jill

Boris Shelby

von (particle not configured)


von Jane

tim Shelby

JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.