Delete wallet accounts

Delete wallet accounts for an organization.

POST

/

public

/

v1

/

submit

/

delete_wallet_accounts

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_DELETE_WALLET_ACCOUNTS

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.walletAccountIds · array · required

List of unique identifiers for wallet accounts within an organization

Show item details

Array item type: string

item field

parameters.deleteWithoutExport

boolean

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

generateAppProofs · boolean

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

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.deleteWalletAccountsIntent

object

required

The deleteWalletAccountsIntent object

Show deleteWalletAccountsIntent details

activity.intent.deleteWalletAccountsIntent.walletAccountIds

array

required

List of unique identifiers for wallet accounts within an organization

Show walletAccountIds details

activity.intent.deleteWalletAccountsIntent.walletAccountIds.item

string

required

item field

activity.intent.deleteWalletAccountsIntent.deleteWithoutExport

boolean

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

activity.result

object

required

The result of the activity

Show result details

activity.result.deleteWalletAccountsResult

object

required

The deleteWalletAccountsResult object

Show deleteWalletAccountsResult details

activity.result.deleteWalletAccountsResult.walletAccountIds

array

required

A list of wallet account unique identifiers that were removed

Show walletAccountIds details

activity.result.deleteWalletAccountsResult.walletAccountIds.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/delete_wallet_accounts \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --header "X-Stamp: <string> (see Authorizations)" \
  --data '{
    "type": "ACTIVITY_TYPE_DELETE_WALLET_ACCOUNTS",
    "timestampMs": "<string> (e.g. 1746736509954)",
    "organizationId": "<string> (Your Organization ID)",
    "parameters": {
        "walletAccountIds": [
            "<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().deleteWalletAccounts({
  walletAccountIds: ["<string>"] // List of unique identifiers for wallet accounts within an organization,
  deleteWithoutExport: true // Optional parameter for deleting the wallet accounts, even if any have not been previously exported. If they have been exported, this field is ignored.
});

200

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