Search
K
Veramask API

HashStrategy

object

Hash detected values using SHA-256.

typestring

Operator type. Must be ‘hash’.

Default:hash

Example

MaskStrategy

object

Mask detected values by replacing part of the text with a masking character.

typestring

Operator type. Must be ‘mask’.

Default:mask

masking_charstring

Character used to mask text.

Default:*

chars_to_maskinteger

Number of characters to mask.

Default:5

>= 1

from_endboolean

If true, masks characters from the end of the detected value.

Default:false

Example

RedactStrategy

object

Redact detected values completely.

typestring

Operator type. Must be ‘redact’.

Default:redact

Example

ReplaceStrategy

object

Replace detected values with a caller-provided fixed value.

typestring

Operator type. Must be ‘replace’.

Default:replace

new_valuestringrequired

Replacement text to use for the detected value.

Example

SubstituteStrategy

object

Substitute detected values with realistic synthetic data using the Faker library.

typestring

Operator type. Must be ‘substitute’.

Default:substitute

attributestring

Faker attribute to use for substitution (for example: name, address, company).

Default:name

Example