Import wallet

Import a wallet.

type · enum<string> · required

Enum options: ACTIVITY_TYPE_IMPORT_WALLET

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

A list of wallet Accounts.

Show item details

generateAppProofs · boolean

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

A successful response returns the following fields:

activity · object · required

The activity object containing type, intent, and result

Show activity details

cURL

curl --request POST \
  --url https://api.turnkey.com/public/v1/submit/import_wallet \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --header "X-Stamp: <string> (see Authorizations)" \
  --data '{
    "type": "ACTIVITY_TYPE_IMPORT_WALLET",
    "timestampMs": "<string> (e.g. 1746736509954)",
    "organizationId": "<string> (Your Organization ID)",
    "parameters": {
        "userId": "<string>",
        "walletName": "<string>",
        "encryptedBundle": "<string>",
        "accounts": [
            {
                "curve": "<CURVE_SECP256K1>",
                "pathFormat": "<PATH_FORMAT_BIP32>",
                "path": "<string>",
                "addressFormat": "<ADDRESS_FORMAT_UNCOMPRESSED>"
            }
        ]
    }
}'

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().importWallet({
  userId: "<string> (The ID of the User importing a Wallet.)",
  walletName: "<string> (Human-readable name for a Wallet.)",
  encryptedBundle: "<string> (Bundle containing a wallet mnemonic encrypted to the enclave's target public key.)",
  accounts: [{ // A list of wallet Accounts.,
    curve: "<CURVE_SECP256K1>" // curve field,
    pathFormat: "<PATH_FORMAT_BIP32>" // pathFormat field,
    path: "<string> (Path used to generate a wallet Account.)",
    addressFormat: "<ADDRESS_FORMAT_UNCOMPRESSED>" // addressFormat field,
  }]
});

200

{
  "activity": {
    "id": "<activity-id>",
    "status": "ACTIVITY_STATUS_COMPLETED",
    "type": "ACTIVITY_TYPE_IMPORT_WALLET",
    "organizationId": "<organization-id>",
    "timestampMs": "<timestamp> (e.g. 1746736509954)",
    "result": {
      "activity": {
        "id": "<string>",
        "organizationId": "<string>",
        "status": "<string>",
        "type": "<string>",
        "intent": {
          "importWalletIntent": {
            "userId": "<string>",
            "walletName": "<string>",
            "encryptedBundle": "<string>",
            "accounts": [
              {
                "curve": "<CURVE_SECP256K1>",
                "pathFormat": "<PATH_FORMAT_BIP32>",
                "path": "<string>",
                "addressFormat": "<ADDRESS_FORMAT_UNCOMPRESSED>"
              }
            ]
          }
        },
        "result": {
          "importWalletResult": {
            "walletId": "<string>",
            "addresses": [
              "<string>"
            ]
          }
        },
        "votes": "<array>",
        "fingerprint": "<string>",
        "canApprove": "<boolean>",
        "canReject": "<boolean>",
        "createdAt": "<string>",
        "updatedAt": "<string>"
      }
    }
  }
}