Import Wallet

Imports a wallet

POST

/

public

/

v1

/

submit

/

import_wallet

Authorizations

API Key

X-Stamp

string

header

required

Webauthn (Passkey)

X-Stamp-Webauthn

string

header

required

Body

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

parameters field

Show details

parameters.userId

string

required

The ID of the User importing a Wallet.

parameters.walletName

string

required

Human-readable name for a Wallet.

parameters.encryptedBundle

string

required

Bundle containing a wallet mnemonic encrypted to the enclave’s target public key.

parameters.accounts · enum<string[]> · required

Enum options: CURVE_SECP256K1, CURVE_ED25519

Show item details

parameters.accounts.curve

enum<string>

required

Enum options: CURVE_SECP256K1, CURVE_ED25519

parameters.accounts.pathFormat

enum<string>

required

Enum options: PATH_FORMAT_BIP32

parameters.accounts.path

string

required

Path used to generate a wallet Account.

parameters.accounts.addressFormat

enum<string>

required

Enum options: ADDRESS_FORMAT_UNCOMPRESSED, ADDRESS_FORMAT_COMPRESSED, ADDRESS_FORMAT_ETHEREUM, ADDRESS_FORMAT_SOLANA, ADDRESS_FORMAT_COSMOS, ADDRESS_FORMAT_TRON, ADDRESS_FORMAT_SUI, ADDRESS_FORMAT_APTOS, ADDRESS_FORMAT_BITCOIN_MAINNET_P2PKH, ADDRESS_FORMAT_BITCOIN_MAINNET_P2SH, ADDRESS_FORMAT_BITCOIN_MAINNET_P2WPKH, ADDRESS_FORMAT_BITCOIN_MAINNET_P2WSH, ADDRESS_FORMAT_BITCOIN_MAINNET_P2TR, ADDRESS_FORMAT_BITCOIN_TESTNET_P2PKH, ADDRESS_FORMAT_BITCOIN_TESTNET_P2SH, ADDRESS_FORMAT_BITCOIN_TESTNET_P2WPKH, ADDRESS_FORMAT_BITCOIN_TESTNET_P2WSH, ADDRESS_FORMAT_BITCOIN_TESTNET_P2TR, ADDRESS_FORMAT_BITCOIN_SIGNET_P2PKH, ADDRESS_FORMAT_BITCOIN_SIGNET_P2SH, ADDRESS_FORMAT_BITCOIN_SIGNET_P2WPKH, ADDRESS_FORMAT_BITCOIN_SIGNET_P2WSH, ADDRESS_FORMAT_BITCOIN_SIGNET_P2TR, ADDRESS_FORMAT_BITCOIN_REGTEST_P2PKH, ADDRESS_FORMAT_BITCOIN_REGTEST_P2SH, ADDRESS_FORMAT_BITCOIN_REGTEST_P2WPKH, ADDRESS_FORMAT_BITCOIN_REGTEST_P2WSH, ADDRESS_FORMAT_BITCOIN_REGTEST_P2TR, ADDRESS_FORMAT_SEI, ADDRESS_FORMAT_XLM, ADDRESS_FORMAT_DOGE_MAINNET, ADDRESS_FORMAT_DOGE_TESTNET, ADDRESS_FORMAT_TON_V3R2, ADDRESS_FORMAT_TON_V4R2, ADDRESS_FORMAT_XRP

Response

A successful response returns the following fields:

activity · object · required

The activity object containing type, intent, and result

Show activity details

activity.type

string

required

The activity type

activity.intent

object

required

The intent of the activity

Show intent details

activity.intent.importWalletIntent

object

required

The importWalletIntent object

Show importWalletIntent details

activity.intent.importWalletIntent.userId

string

required

The ID of the User importing a Wallet.

activity.intent.importWalletIntent.walletName

string

required

Human-readable name for a Wallet.

activity.intent.importWalletIntent.encryptedBundle

string

required

Bundle containing a wallet mnemonic encrypted to the enclave’s target public key.

activity.intent.importWalletIntent.accounts

array

required

A list of wallet Accounts.

Show accounts details

activity.intent.importWalletIntent.accounts.curve

enum

required

curve field

Enum options: CURVE_SECP256K1, CURVE_ED25519

activity.intent.importWalletIntent.accounts.pathFormat

enum

required

pathFormat field

Enum options: PATH_FORMAT_BIP32

activity.intent.importWalletIntent.accounts.path

string

required

Path used to generate a wallet Account.

activity.intent.importWalletIntent.accounts.addressFormat

enum

required

addressFormat field

Enum options: ADDRESS_FORMAT_UNCOMPRESSED, ADDRESS_FORMAT_COMPRESSED, ADDRESS_FORMAT_ETHEREUM, ADDRESS_FORMAT_SOLANA, ADDRESS_FORMAT_COSMOS, ADDRESS_FORMAT_TRON, ADDRESS_FORMAT_SUI, ADDRESS_FORMAT_APTOS, ADDRESS_FORMAT_BITCOIN_MAINNET_P2PKH, ADDRESS_FORMAT_BITCOIN_MAINNET_P2SH, ADDRESS_FORMAT_BITCOIN_MAINNET_P2WPKH, ADDRESS_FORMAT_BITCOIN_MAINNET_P2WSH, ADDRESS_FORMAT_BITCOIN_MAINNET_P2TR, ADDRESS_FORMAT_BITCOIN_TESTNET_P2PKH, ADDRESS_FORMAT_BITCOIN_TESTNET_P2SH, ADDRESS_FORMAT_BITCOIN_TESTNET_P2WPKH, ADDRESS_FORMAT_BITCOIN_TESTNET_P2WSH, ADDRESS_FORMAT_BITCOIN_TESTNET_P2TR, ADDRESS_FORMAT_BITCOIN_SIGNET_P2PKH, ADDRESS_FORMAT_BITCOIN_SIGNET_P2SH, ADDRESS_FORMAT_BITCOIN_SIGNET_P2WPKH, ADDRESS_FORMAT_BITCOIN_SIGNET_P2WSH, ADDRESS_FORMAT_BITCOIN_SIGNET_P2TR, ADDRESS_FORMAT_BITCOIN_REGTEST_P2PKH, ADDRESS_FORMAT_BITCOIN_REGTEST_P2SH, ADDRESS_FORMAT_BITCOIN_REGTEST_P2WPKH, ADDRESS_FORMAT_BITCOIN_REGTEST_P2WSH, ADDRESS_FORMAT_BITCOIN_REGTEST_P2TR, ADDRESS_FORMAT_SEI, ADDRESS_FORMAT_XLM, ADDRESS_FORMAT_DOGE_MAINNET, ADDRESS_FORMAT_DOGE_TESTNET, ADDRESS_FORMAT_TON_V3R2, ADDRESS_FORMAT_TON_V4R2, ADDRESS_FORMAT_XRP

activity.result

object

required

The result of the activity

Show result details

activity.result.importWalletResult

object

required

The importWalletResult object

Show importWalletResult details

activity.result.importWalletResult.walletId

string

required

Unique identifier for a Wallet.

activity.result.importWalletResult.addresses

array

required

A list of account addresses.

Show addresses details

activity.result.importWalletResult.addresses.item

string

required

item field

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: <YOUR_API_KEY.YOUR_API_SECRET>" \
  --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>"
            }
        ]
    }
}'

200

{
  "activity": {
    "id": "<activity-id>",
    "status": "ACTIVITY_STATUS_COMPLETED",
    "type": "ACTIVITY_TYPE_IMPORT_WALLET",
    "organizationId": "<organization-id>",
    "timestampMs": "<timestamp> (e.g. 1746736509954)",
    "result": {
      "activity": {
        "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_element>"
            ]
          }
        }
      }
    }
  }
}