Skip to main content

Bulk Decrypt Data

This API decrypts multiple ciphertext values across one or more encryption configurations in a single request. Each encryption configuration is identified by its unique function_id, and the API returns the corresponding plaintext for each ciphertext item.


Endpoint Details

URL /v1/crypto/bulk-decrypt
Method POST
Authorization Bearer Token

Request Headers

HeaderTypeDescription
Content-TypeStringMust be application/json

Request Body

Use the following format to make a request:

JSON Request
{
"data": [
{
"function_id": "ab063593-5dd8-4b9c-a24b-fbd66190cc85",
"items": [
{
"ciphertext": "v1:7qMnVsYUWv8SG3FpxrLd0w3zNr3ATtWeUWdRmH7nXBUAS9A="
},
{
"ciphertext": "v1:+ekQmVs1Dk2b01JI7BYb2RLBcB6y48gtE3LV8sNGVRCCrvuO4g=="
}
]
}
]
}

Parameters

ParameterTypeDescription
dataArrayList of decryption requests grouped by encryption configuration
function_idUUIDUnique identifier of the encryption configuration used to decrypt the data
itemsArrayList of ciphertext values to be decrypted using the specified encryption configuration
plaintextStringEncrypted data to be decrypted

Response

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

Response
{
"data": [
{
"security_config_id": "ab063593-5dd8-4b9c-a24b-fbd66190cc85",
"security_config_type": 1,
"items": [
{
"ciphertext": "v1:7qMnVsYUWv8SG3FpxrLd0w3zNr3ATtWeUWdRmH7nXBUAS9A=",
"plaintext": "jakarta",
"success": true
},
{
"ciphertext": "v1:+ekQmVs1Dk2b01JI7BYb2RLBcB6y48gtE3LV8sNGVRCCrvuO4g==",
"plaintext": "tangerang",
"success": true
}
]
}
]
}

Field Descriptions

FieldTypeDescription
security_config_idUUIDUnique identifier of the encryption configuration used to decrypt the data
security_config_typeIntegerType of the security configuration
itemsArrayList of decryption results
ciphertextStringEncrypted input provided in the request
plaintextStringDecrypted plaintext generated from the corresponding ciphertext
successBooleanIndicates whether the decryption operation completed successfully

info
  • A valid Bearer Token is required to access this endpoint.
  • Each function_id must refer to an existing encryption configuration.
  • The security_config_type field indicates the type of security configuration used:
    • 1 = Encryption
    • 2 = Tokenization
    • 3 = Masking
  • A single request can include multiple encryption configurations, each containing one or more ciphertext values to decrypt.
  • The API returns the decrypted plaintext for each successfully processed ciphertext.