Create private key tag

Create a private key tag and add it to private keys.

POST

/

public

/

v1

/

submit

/

create_private_key_tag

Authorizations

API Key

X-Stamp · string · required

Cryptographically signed (stamped) request to be passed in as a header. For more info, see here.

WebAuthn (Passkey)

X-Stamp-WebAuthn · string · required

Cryptographically signed (stamped) request to be passed in as a header. For more info, see here.

Body

type · enum<string> · required

Enum options: ACTIVITY_TYPE_CREATE_PRIVATE_KEY_TAG

timestampMs · string · required

Timestamp (in milliseconds) of the request, used to verify liveness of user requests.

organizationId · string · required

Unique identifier for a given Organization.

parameters · object · required

The parameters object containing the specific intent data for this activity.

Show details

parameters.privateKeyTagName

string

required

Human-readable name for a Private Key Tag.

parameters.privateKeyIds · array · required

A list of Private Key IDs.

Show item details

Array item type: string

item field

Response

A successful response returns the following fields:

activity · object · required

The activity object containing type, intent, and result

Show activity details

activity.id

string

required

Unique identifier for a given Activity object.

activity.organizationId

string

required

Unique identifier for a given Organization.

activity.status

string

required

The activity status

activity.type

string

required

The activity type

activity.intent

object

required

The intent of the activity

Show intent details

activity.intent.createPrivateKeyTagIntent

object

required

The createPrivateKeyTagIntent object

Show createPrivateKeyTagIntent details

activity.intent.createPrivateKeyTagIntent.privateKeyTagName

string

required

Human-readable name for a Private Key Tag.

activity.intent.createPrivateKeyTagIntent.privateKeyIds

array

required

A list of Private Key IDs.

Show privateKeyIds details

activity.intent.createPrivateKeyTagIntent.privateKeyIds.item

string

required

item field

activity.result

object

required

The result of the activity

Show result details

activity.result.createPrivateKeyTagResult

object

required

The createPrivateKeyTagResult object

Show createPrivateKeyTagResult details

activity.result.createPrivateKeyTagResult.privateKeyTagId

string

required

Unique identifier for a given Private Key Tag.

activity.result.createPrivateKeyTagResult.privateKeyIds

array

required

A list of Private Key IDs.

Show privateKeyIds details

activity.result.createPrivateKeyTagResult.privateKeyIds.item

string

required

item field

activity.votes

array

required

A list of objects representing a particular User’s approval or rejection of a Consensus request, including all relevant metadata.

activity.fingerprint

string

required

An artifact verifying a User’s action.

activity.canApprove

boolean

required

Whether the activity can be approved.

activity.canReject

boolean

required

Whether the activity can be rejected.

activity.createdAt

string

required

The creation timestamp.

activity.updatedAt

string

required

The last update timestamp.

cURL

curl --request POST \
  --url https://api.turnkey.com/public/v1/submit/create_private_key_tag \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --header "X-Stamp: <string> (see Authorizations)" \
  --data '{
    "type": "ACTIVITY_TYPE_CREATE_PRIVATE_KEY_TAG",
    "timestampMs": "<string> (e.g. 1746736509954)",
    "organizationId": "<string> (Your Organization ID)",
    "parameters": {
        "privateKeyTagName": "<string>",
        "privateKeyIds": [
            "<string>"
        ]
    }
}'

import { Turnkey } from "@turnkey/sdk-server";

const turnkeyClient = new Turnkey({
  apiBaseUrl: "https://api.turnkey.com",
  apiPublicKey: process.env.API_PUBLIC_KEY!,
  apiPrivateKey: process.env.API_PRIVATE_KEY!,
  defaultOrganizationId: process.env.ORGANIZATION_ID!,
});

const response = await turnkeyClient.apiClient().createPrivateKeyTag({
  privateKeyTagName: "<string> (Human-readable name for a Private Key Tag.)",
  privateKeyIds: ["<string>"] // A list of Private Key IDs.
});

200

{
  "activity": {
    "id": "<activity-id>",
    "status": "ACTIVITY_STATUS_COMPLETED",
    "type": "ACTIVITY_TYPE_CREATE_PRIVATE_KEY_TAG",
    "organizationId": "<organization-id>",
    "timestampMs": "<timestamp> (e.g. 1746736509954)",
    "result": {
      "activity": {
        "id": "<string>",
        "organizationId": "<string>",
        "status": "<string>",
        "type": "<string>",
        "intent": {
          "createPrivateKeyTagIntent": {
            "privateKeyTagName": "<string>",
            "privateKeyIds": [
              "<string>"
            ]
          }
        },
        "result": {
          "createPrivateKeyTagResult": {
            "privateKeyTagId": "<string>",
            "privateKeyIds": [
              "<string>"
            ]
          }
        },
        "votes": "<array>",
        "fingerprint": "<string>",
        "canApprove": "<boolean>",
        "canReject": "<boolean>",
        "createdAt": "<string>",
        "updatedAt": "<string>"
      }
    }
  }
}