Search
K
Veramask API

AnonymizeRequest

object

Request payload for the text anonymization endpoint.

settingsobject

Optional global settings for locale, confidence threshold, and consistency.

Show Child Parameters
overridesobject

Per-entity anonymization overrides keyed by entity type (for example: PERSON, PHONE_NUMBER, EMAIL_ADDRESS).

datastringrequired

Raw input text containing sensitive data to anonymize.

Example

AnonymizeSettings

object

Global processing options applied to the anonymization request.

localestring

Locale used during entity detection. Currently supported: en_US.

Default:en_US

confidence_thresholdnumber

Minimum analyzer confidence score (0.0 to 1.0).

Default:0.4

>= 0<= 1

consistency_saltAny Of

Optional salt used for deterministic hashing across requests. When provided, it must be at least 16 bytes.

Default:

Variant 1string
Example

HTTPValidationError

object
detailarray[object]
Show Child Parameters
Example

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