Search
K
Veramask API

Anonymize Text

Anonymize sensitive entities in free text with configurable strategies.

post
https://veramask-gateway-3irxmt23.uc.gateway.dev/v1/anonymizeText

Body

application/json

AnonymizeRequest

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.

Response

application/json

Successful Response

post/v1/anonymizeText

Body

{ "data": "Alice Smith can be reached at asmith@mygoogle.com" }
 
application/json

Anonymize JSON

Apply anonymization to all values in a JSON object while preserving the original structure.

post
https://veramask-gateway-3irxmt23.uc.gateway.dev/v1/anonymizeJSON

Body

application/json

AnonymizeJsonRequest

Request payload for the JSON 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).

dataobjectrequired

JSON object to anonymize. Validation is applied recursively to all attribute values.

* Additional properties are allowed.

Response

application/json

Successful Response

post/v1/anonymizeJSON

Body

{ "data": { "customer": { "name": "Alice Smith", "email": "alice@example.com" }, "notes": [ "Home address: 7211 Jewel Lake Rd, Anchorage, Alaska" ] } }
 
application/json

AnonymizeJsonRequest

object

Request payload for the JSON 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).

dataobjectrequired

JSON object to anonymize. Validation is applied recursively to all attribute values.

* Additional properties are allowed.
Example

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