Masking Options API

GET /v1/integration/masking-options

Summary

Retrieve the available masking options for use with the masking API (/v1/integration/mask-data).

Request Headers

Header	Value	Description
Authorization	Bearer API_TOKEN	The API token required for authentication.

Responses

200: Successful Response

The successful response returns a JSON object containing the available masking options.

{
  "masking_options": [
    {
      "name": "email",
      "label": "Email Address",
      "description": "Mask email addresses",
      "example": "ex****@gmail.com"
    },
    {
      "name": "card_number",
      "label": "Credit/Debit Card Number",
      "description": "Mask credit/debit card numbers",
      "example": "**** **** **** 1234"
    },
    {
      "name": "phone",
      "label": "Phone Number",
      "description": "Mask phone numbers",
      "example": "+12 *** *** 789"
    },
    {
      "name": "uuid",
      "label": "UUID",
      "description": "Mask UUID strings",
      "example": "abcd1234-4f47-1aa0-0ee1-abcd1234"
    },
    {
      "name": "jwt",
      "label": "JWT Token",
      "description": "Mask JWT tokens",
      "example": "eyJhbGciOiJ.****.DJYQmNCbA"
    },
    {
      "name": "password",
      "label": "Password or High-Entropy Data",
      "description": "Mask high entropy data",
      "example": "************"
    },
    {
      "name": "random_string",
      "label": "Random String",
      "description": "Mask random strings",
      "example": "a0m3lJvZuDeD"
    },
    {
      "name": "integer",
      "label": "Integer",
      "description": "Mask integers with random values close to the original",
      "example": "42 → 45"
    },
    {
      "name": "float",
      "label": "Float",
      "description": "Mask floats with random values close to the original",
      "example": "42.42 → 43.12"
    }
  ]
}