PII anonymization and de-anonymization

Authorizations

apikey

string

header

required

Body

application/json

text

string

required

mode

enum<string>

default:request

required

Available options:

request,

response

key

string

user_metadata

object

Optional arbitrary metadata object echoed back in the response. Limits: at most 16 top-level keys, key names up to 64 characters, nesting depth up to 3, total serialized size up to 4 KB. When provided and valid, this object is also echoed as a top-level user_metadata key on error responses (4xx/5xx) of endpoints that accept it; invalid or oversized metadata is never echoed, including on the 422 response it causes.

Example:

{
  "request_id": "abc-123",
  "source": "mobile-app"
}

Response

200 - application/json

Successful Response

In response mode (de-anonymization), user_metadata reflects the value cached alongside the PII mapping from the original request-mode call (1 hour TTL), not a new value from the current request.

text

string

key

string

user_metadata

object

Optional arbitrary metadata object echoed back in the response. Limits: at most 16 top-level keys, key names up to 64 characters, nesting depth up to 3, total serialized size up to 4 KB. When provided and valid, this object is also echoed as a top-level user_metadata key on error responses (4xx/5xx) of endpoints that accept it; invalid or oversized metadata is never echoed, including on the 422 response it causes.

Example:

{
  "request_id": "abc-123",
  "source": "mobile-app"
}