List Tokenization
This API returns a list of tokenization functions available within the tenant.
Endpoint Details
| URL | /v1/tokenize/functions |
| Method | GET |
| Authorization | Bearer Token |
Request Headers
| Header | Type | Description |
|---|---|---|
| Content-Type | String | Must be application/json |
Response
Here is an example of a response when viewing a list of data:
Response
{
"functions": [
{
"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
},
{
"id": "07b2e230-7a94-4d04-9251-c3d5aac89d05",
"name": "Dummy 2",
"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": 1783569945,
"updated_at": 1783569945,
"lock_ring_id": "tokenize/07b2e230-7a94-4d04-9251-c3d5aac89d05",
"exportable": true
},
{
"id": "a283eda2-ebbb-4948-b470-562ddc23a6cb",
"name": "Testtt 2",
"method": "FF3_1",
"tweak_type": "internal",
"data_type": "Identifier",
"sub_type": "NIK",
"partial": {
"enabled": true,
"type": "Percentage",
"left": 30,
"right": 20
},
"group_id": "81ad4d05-d11a-4809-b1f2-cc000c086730",
"created_by": "0a937c60-0ed4-4d06-870a-2e284b54287d",
"updated_by": "0a937c60-0ed4-4d06-870a-2e284b54287d",
"created_at": 1783569755,
"updated_at": 1783569755,
"lock_ring_id": "tokenize/a283eda2-ebbb-4948-b470-562ddc23a6cb",
"assigned_user_ids": [
"0a937c60-0ed4-4d06-870a-2e284b54287d"
],
"exportable": true
},
{
"id": "fb5025cd-baa1-4ba3-8942-dafa48460177",
"name": "Tessstt",
"method": "FF1",
"tweak_type": "generated",
"data_type": "General",
"sub_type": "IMEI",
"partial": {
"enabled": true,
"type": "Character",
"left": 2,
"right": 3
},
"group_id": "81ad4d05-d11a-4809-b1f2-cc000c086730",
"created_by": "0a937c60-0ed4-4d06-870a-2e284b54287d",
"updated_by": "0a937c60-0ed4-4d06-870a-2e284b54287d",
"created_at": 1783569462,
"updated_at": 1783569462,
"lock_ring_id": "tokenize/fb5025cd-baa1-4ba3-8942-dafa48460177",
"assigned_user_ids": [
"0a937c60-0ed4-4d06-870a-2e284b54287d"
]
},
{
"id": "dee0cdcb-3f93-4af2-a569-c280b53b1a3b",
"name": "Dummy 1",
"method": "FF3_1",
"tweak_type": "internal",
"data_type": "Custom",
"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": 1783569138,
"updated_at": 1783569138,
"lock_ring_id": "tokenize/dee0cdcb-3f93-4af2-a569-c280b53b1a3b"
},
{
"id": "ab1970dc-044f-4f8c-8db4-5644ee363cd9",
"name": "Dummy",
"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": 1783568938,
"updated_at": 1783568938,
"lock_ring_id": "tokenize/ab1970dc-044f-4f8c-8db4-5644ee363cd9"
}
],
"pagination": {
"total": 6,
"page": 1,
"page_size": 6,
"last_page": 1
}
}
Field Descriptions
| Field | Type | Description |
|---|---|---|
| id | UUID | Unique identifier of the tokenization function |
| name | String | Name of the tokenization function |
| method | String | Format-preserving encryption method used by the function |
| tweak_type | String | Type of tweak used by the tokenization method |
| data_type | String | Category of data to be tokenized |
| sub_type | String | Specific data sub-type within the selected data type |
| partial | Object | Partial tokenization function |
| partial.enabled | Boolean | Indicates whether partial tokenization is enabled |
| partial.type | String | Partial tokenization type |
| partial.left | Integer | Number of leftmost units preserved during partial tokenization |
| partial.right | Integer | Number of rightmost units preserved during partial tokenization |
| group_id | UUID | Identifier of the associated group |
| created_by | UUID | Identifier of the user who created the function |
| updated_by | UUID | Identifier of the user who last updated the function |
| created_at | Integer | Creation timestamp in Unix format |
| updated_at | Integer | Last update timestamp in Unix format |
| lock_ring_id | String | Internal identifier associated with the tokenization function |
| assigned_user_ids | Array | List of user IDs assigned to the tokenization function |
| exportable | Boolean | Indicates whether the tokenization key can be exported |
| total | Integer | Total number of tokenization functions available |
| page | Integer | Current page number |
| page_size | Integer | Number of records returned per page |
| last_page | Integer | Total number of available pages |
info
- A valid Bearer Token is required to access this endpoint.
- The response returns all tokenization functions available to the authenticated user within the tenant.
- Some fields such as
partial,assigned_user_ids, andexportablemay not be present if those options were not configured when the tokenization function was created. - Unix timestamp fields can be converted to a human-readable date and time format as needed.