Tokenize

POST https://%7B%7Bvault_uri%7D%7D.vault.skyflowapis.com/v1/vaults/{vaultID}/tokenize
Content-Type: application/json

Returns tokens that correspond to the specified records. Only applicable for fields with deterministic tokenization.Note: This endpoint doesn’t insert records—it returns tokens for existing values. To insert records and return tokens for that new record’s values, see Insert Records’ tokenization parameter.

Authentication

• Authorization header (bearer token, required) — Access token, prefixed by Bearer .

Servers

• https://%7B%7Bvault_uri%7D%7D.vault.skyflowapis.com (Production, default)
• https://%7B%7Bvault_uri%7D%7D.vault.skyflowapis-preview.com (Sandbox)

Request

Path parameters

• vaultID (string, required) — ID of the vault.

Body (application/json)

This endpoint expects an object.

• tokenizationParameters (list of object, required) — Tokenization details.
  • value (string, optional) — Existing value to return a token for. Must be specified with either columnGroup or both table and column.
  • table (string, optional) — Name of the table that the value belongs to. Must be specified with column. Can’t be specified with columnGroup.
  • column (string, optional) — Name of the column that the value belongs to. Must be specified with table. Can’t be specified with columnGroup.
  • columnGroup (string, optional) — Name of the column group that the value belongs to. Can’t be specified with table or column.

Response

200

OK

• records (list of object, required) — Tokens corresponding to the specified values.
  • token (string, required) — Token corresponding to a value.

Errors

400 Bad Request Error

Returned when the request is invalid or cannot be served.

• error (object, required)
  • grpc_code (integer, required) — gRPC status codes. See https://grpc.io/docs/guides/status-codes.
  • http_code (integer, required) — HTTP status codes. See https://developer.mozilla.org/en-US/docs/Web/HTTP/Status.
  • http_status (string, required)
  • message (string, required)
  • details (list of map from string to any, optional)

401 Unauthorized Error

Returned when the request is unauthorized.

• error (object, required)
  • grpc_code (integer, required) — gRPC status codes. See https://grpc.io/docs/guides/status-codes.
  • http_code (integer, required) — HTTP status codes. See https://developer.mozilla.org/en-US/docs/Web/HTTP/Status.
  • http_status (string, required)
  • message (string, required)
  • details (list of map from string to any, optional)

404 Not Found Error

Returned when a resource doesn’t exist.

• error (object, required)
  • grpc_code (integer, required) — gRPC status codes. See https://grpc.io/docs/guides/status-codes.
  • http_code (integer, required) — HTTP status codes. See https://developer.mozilla.org/en-US/docs/Web/HTTP/Status.
  • http_status (string, required)
  • message (string, required)
  • details (list of map from string to any, optional)

422 Unprocessable Entity Error

Returned when the request is well-formed but contains semantic errors that prevent it from being processed.

• error (object, required)
  • grpc_code (integer, required) — gRPC status codes. See https://grpc.io/docs/guides/status-codes.
  • http_code (integer, required) — HTTP status codes. See https://developer.mozilla.org/en-US/docs/Web/HTTP/Status.
  • http_status (string, required)
  • message (string, required)
  • details (list of map from string to any, optional)

500 Internal Server Error

An unexpected error response.

• error (object, required)
  • grpc_code (integer, required) — gRPC status codes. See https://grpc.io/docs/guides/status-codes.
  • http_code (integer, required) — HTTP status codes. See https://developer.mozilla.org/en-US/docs/Web/HTTP/Status.
  • http_status (string, required)
  • message (string, required)
  • details (list of map from string to any, optional)

Examples

Request

{
  "tokenizationParameters": [
    {}
  ]
}

Response

{
  "records": [
    {
      "token": "04/75/6955"
    }
  ]
}

SDK Code

import requests

url = "https://{{vault_uri}}.vault.skyflowapis.com/v1/vaults/vaultID/tokenize"

payload = { "tokenizationParameters": [{}] }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.json())

const url = 'https://{{vault_uri}}.vault.skyflowapis.com/v1/vaults/vaultID/tokenize';
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"tokenizationParameters":[{}]}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

package main

import (
  "fmt"
  "strings"
  "net/http"
  "io"
)

func main() {

  url := "https://{{vault_uri}}.vault.skyflowapis.com/v1/vaults/vaultID/tokenize"

  payload := strings.NewReader("{\n  \"tokenizationParameters\": [\n    {}\n  ]\n}")

  req, _ := http.NewRequest("POST", url, payload)

  req.Header.Add("Authorization", "Bearer <token>")
  req.Header.Add("Content-Type", "application/json")

  res, _ := http.DefaultClient.Do(req)

  defer res.Body.Close()
  body, _ := io.ReadAll(res.Body)

  fmt.Println(res)
  fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://{{vault_uri}}.vault.skyflowapis.com/v1/vaults/vaultID/tokenize")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"tokenizationParameters\": [\n    {}\n  ]\n}"

response = http.request(request)
puts response.read_body

import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.post("https://{{vault_uri}}.vault.skyflowapis.com/v1/vaults/vaultID/tokenize")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"tokenizationParameters\": [\n    {}\n  ]\n}")
  .asString();

<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://{{vault_uri}}.vault.skyflowapis.com/v1/vaults/vaultID/tokenize', [
  'body' => '{
  "tokenizationParameters": [
    {}
  ]
}',
  'headers' => [
    'Authorization' => 'Bearer <token>',
    'Content-Type' => 'application/json',
  ],
]);

echo $response->getBody();

using RestSharp;

var client = new RestClient("https://{{vault_uri}}.vault.skyflowapis.com/v1/vaults/vaultID/tokenize");
var request = new RestRequest(Method.POST);
request.AddHeader("Authorization", "Bearer <token>");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{\n  \"tokenizationParameters\": [\n    {}\n  ]\n}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);

import Foundation

let headers = [
  "Authorization": "Bearer <token>",
  "Content-Type": "application/json"
]
let parameters = ["tokenizationParameters": [[]]] as [String : Any]

let postData = JSONSerialization.data(withJSONObject: parameters, options: [])

let request = NSMutableURLRequest(url: NSURL(string: "https://{{vault_uri}}.vault.skyflowapis.com/v1/vaults/vaultID/tokenize")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()