Masking Data

This API masks plaintext using an existing masking function. The masking function is identified by its unique ID, and the API returns the masked data.

---

Endpoint Details

URL	/v1/masking
Method	POST
Authorization	Bearer Token

---

Request Headers

Header	Type	Description
Content-Type	String	Must be application/json

---

Request Body

Use the following format to make a request:

JSON Request

{
  "function_id": "5b41077a-97d1-4bc7-adf4-124025a1758b",
  "plaintext": "0812345678912"
}

---

Parameters

Parameter	Type	Description
function_id	UUID	Unique identifier of the masking function used to perform masking
plaintext	String	Plaintext data to be masked

---

Response

Here is an example response after the request has been successfully processed:

Response

{
    "masked_data": "!!!!!!56!!91!"
}

---

Field Descriptions

Field	Type	Description
masked_data	String	Masked output generated from the provided plaintext using the specified masking function

---

info

• A valid Bearer Token is required to access this endpoint.
• The function_id must refer to an existing masking function.
• The masking result depends on the masking type and settings configured in the masking function.