Bulk Detokenize Data

This API detokenizes multiple ciphertext values across one or more tokenization functions in a single request. Each tokenization function is identified by its unique function_id, and the API returns the corresponding plaintext for every ciphertext item.

---

Endpoint Details

URL	/v1/tokenize/bulk-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

{
    "data": [
        {
            "function_id": "dfae2591-01de-4beb-a8e2-f6c7ddf5f069",
            "items": [
                {
                    "ciphertext": "%tz5lx@bmb2dkr.hhr",
                    "tweak_hex": "1234abcd"
                }
            ]
        },
        {
            "function_id": "a6a47f65-ed08-4383-be09-ffee076d9458",
            "items": [
                {
                    "ciphertext": "588086082643540",
                    "tweak_hex": "302f511f2714ee"
                }
            ]
        }
    ]
}

---

Parameters

Parameter	Type	Description
data	Array	List of detokenization requests grouped by tokenization function
function_id	UUID	Unique identifier of the tokenization function used to perform detokenization
items	Array	List of ciphertext values to be detokenized using the specified configuration
ciphertext	String	Tokenized data to be detokenized
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

{
    "data": [
        {
            "function_id": "dfae2591-01de-4beb-a8e2-f6c7ddf5f069",
            "items": [
                {
                    "ciphertext": "%tz5lx@bmb2dkr.hhr",
                    "plaintext": "member@example.com"
                }
            ]
        },
        {
            "function_id": "a6a47f65-ed08-4383-be09-ffee076d9458",
            "items": [
                {
                    "ciphertext": "588086082643540",
                    "plaintext": "861234056789012"
                }
            ]
        }
    ]
}

---

Field Descriptions

Field	Type	Description
data	Array	List of detokenization results grouped by tokenization function
function_id	UUID	Unique identifier of the tokenization function used
items	Array	List of detokenization results
ciphertext	String	Tokenized input provided in the request
plaintext	String	Original plaintext obtained from the corresponding ciphertext

---

info

• A valid Bearer Token is required to access this endpoint.
• Each function_id must refer to an existing tokenization function.
• A single request can include multiple tokenization functions, each containing one or more ciphertext values to detokenize.
• Each ciphertext must be generated using the same tokenization function (function_id) provided for its detokenization.
• 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.