delete-private-keys.mdx

title	Delete private keys
description	Delete private keys for an organization.

import { Authorizations } from "/snippets/api/authorizations.mdx"; import { H3Bordered } from "/snippets/h3-bordered.mdx"; import { NestedParam } from "/snippets/nested-param.mdx"; import { EndpointPath } from "/snippets/api/endpoint.mdx";

Enum options: ACTIVITY_TYPE_DELETE_PRIVATE_KEYS

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

Unique identifier for a given Organization.

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

List of unique identifiers for private keys within an organization

Array item type: string

item field

Optional parameter for deleting the private keys, even if any have not been previously exported. If they have been exported, this field is ignored.

Enable to have your activity generate and return App Proofs, enabling verifiability.

A successful response returns the following fields: The activity object containing type, intent, and result Unique identifier for a given Activity object. Unique identifier for a given Organization. The activity status The activity type The intent of the activity The deletePrivateKeysIntent object List of unique identifiers for private keys within an organization item field

  </Expandable>
</NestedParam>

Optional parameter for deleting the private keys, even if any have not been previously exported. If they have been exported, this field is ignored.

  </Expandable>
</NestedParam>

  </Expandable>
</NestedParam>

The result of the activity The deletePrivateKeysResult object A list of private key unique identifiers that were removed item field

  </Expandable>
</NestedParam>

  </Expandable>
</NestedParam>

  </Expandable>
</NestedParam>

A list of objects representing a particular User's approval or rejection of a Consensus request, including all relevant metadata. An artifact verifying a User's action. Whether the activity can be approved. Whether the activity can be rejected. The creation timestamp. The last update timestamp.

For a detailed breakdown of potential error codes, please refer to our Error Documentation.

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

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().deletePrivateKeys({
  privateKeyIds: ["<string>"] // List of unique identifiers for private keys within an organization,
  deleteWithoutExport: true // Optional parameter for deleting the private keys, even if any have not been previously exported. If they have been exported, this field is ignored.
});

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