Batch Detokenize Data

This API detokenizes multiple ciphertext values using a single tokenization function in one request. The tokenization function is identified by its unique function_id, and the API returns the corresponding plaintext for each ciphertext.

---

Endpoint Details

URL	/v1/tokenize/batch-detokenize
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": "dfae2591-01de-4beb-a8e2-f6c7ddf5f069",
  "ciphertexts": [
    "ca7+mez@3v1pje3.jsw",
    "yhp9yu-@3v1pje3.jsw"
  ],
  "tweak_hex": "302f511f27ee"
}

---

Parameters

Parameter	Type	Description
function_id	UUID	Unique identifier of the tokenization function used to perform detokenization
ciphertexts	Array	List of ciphertext values to be detokenized using the specified configuration
tweak_hex	String	Tweak value in hexadecimal format, required when the configuration uses the Generated or Supplied tweak type

---

Response

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

Response

{
    "results": [
        {
            "plaintext": "member1@example.com"
        },
        {
            "plaintext": "member2@example.com"
        }
    ]
}

---

Field Descriptions

Field	Type	Description
results	Array	List of detokenization results in the same order as the input
plaintext	String	Original plaintext obtained from the corresponding ciphertext

---

info

• A valid Bearer Token is required to access this endpoint.
• The function_id must refer to an existing tokenization function.
• All ciphertext values in a single request are detokenized using the same tokenization function.
• The results array preserves the same order as the ciphertexts provided in the request.
• tweak_hex is only required when the tokenization function uses the Generated or Supplied tweak type. It can be left empty for the Internal tweak type.
• The tweak_hex value must be at least 8 characters (hex).
• For more details on tweak types, refer to the User Guide.