Skip to main content

Detail Tokenization by ID

This API returns detailed information about a specific tokenization function identified by ID.


Endpoint Details

URL /v1/tokenize/functions/id
Method GET
Authorization Bearer Token

Request Headers

HeaderTypeDescription
Content-TypeStringMust be application/json

Request Path

To retrieve the details of a specific tokenization function, use the following request format:

/v1/tokenize/functions/f30f8335-8bf3-4cfd-8ca9-80ef48b84650

Path Parameter

ParameterTypeDescription
idUUIDUnique identifier of the tokenization function

Response

Here is an example of a response when viewing data details:

Response
{
"function": {
"id": "f30f8335-8bf3-4cfd-8ca9-80ef48b84650",
"name": "Dummy 3",
"method": "FF3_1",
"tweak_type": "internal",
"data_type": "General",
"sub_type": "Email",
"group_id": "81ad4d05-d11a-4809-b1f2-cc000c086730",
"created_by": "0a937c60-0ed4-4d06-870a-2e284b54287d",
"updated_by": "0a937c60-0ed4-4d06-870a-2e284b54287d",
"created_at": 1783580158,
"updated_at": 1783580158,
"lock_ring_id": "tokenize/f30f8335-8bf3-4cfd-8ca9-80ef48b84650",
"exportable": true
}
}

Field Descriptions

FieldTypeDescription
idUUIDUnique identifier of the tokenization function
nameStringName of the tokenization function
methodStringFormat-preserving encryption method used by the function
tweak_typeStringType of tweak used by the tokenization method
data_typeStringCategory of data to be tokenized
sub_typeStringSpecific data sub-type within the selected data type
group_idUUIDIdentifier of the associated group
created_byUUIDIdentifier of the user who created the function
updated_byUUIDIdentifier of the user who last updated the function
created_atIntegerCreation timestamp in Unix format
updated_atIntegerLast update timestamp in Unix format
lock_ring_idStringInternal identifier associated with the tokenization function
exportableBooleanIndicates whether the tokenization key can be exported

info
  • A valid Bearer Token is required to access this endpoint.
  • The id path parameter must reference an existing tokenization function.
  • Unix timestamp fields can be converted to a human-readable date and time format as needed.