@spec add_asset(String.t(), String.t(), String.t(), String.t()) :: map()

Add an asset to a specific account within a Non-Custodial Wallet.

operationId: AddEmbeddedWalletAsset

@spec assign_wallet(String.t(), String.t()) :: map()

Assign a specific Non-Custodial Wallet to a user.

operationId: assignEmbeddedWallet

@spec create_account(String.t(), String.t()) :: map()

Create a new account under a specific Non-Custodial Wallet.

operationId: CreateEmbeddedWalletAccount

@spec create_wallet(String.t()) :: map()

Create a new Non-Custodial Wallet.

operationId: CreateEmbeddedWallet

@spec get_account(String.t(), String.t()) :: map()

Get a specific account under a specific Non-Custodial Wallet.

operationId: GetEmbeddedWalletAccount

@spec get_addresses(String.t(), String.t(), String.t(), keyword()) :: map()

Get addresses for a specific asset under a specific account within a Non-Custodial Wallet.

operationId: GetEmbeddedWalletAddresses

Options

• :pageCursor (String.t/0) - Cursor to the next page of results

• :pageSize (integer/0) - Number of items per page (min 1, max 100)

• :sort - Field to sort by: :address or :createdAt The default value is :createdAt.

• :order - Sort direction: :asc or :desc The default value is :asc.

• :enabled (boolean/0) - When set, filters addresses by their enabled/disabled status

@spec get_asset(String.t(), String.t(), String.t()) :: map()

Get a specific asset under a specific account within a Non-Custodial Wallet.

operationId: GetEmbeddedWalletAsset

@spec get_asset_balance(String.t(), String.t(), String.t()) :: map()

Get the balance of a specific asset under a specific account within a Non-Custodial Wallet.

operationId: GetEmbeddedWalletAssetBalance

@spec get_asset_public_key_info(
  String.t(),
  String.t(),
  String.t(),
  non_neg_integer(),
  non_neg_integer(),
  keyword()
) :: map()

Get the public key of an asset associated with a specific account within a Non-Custodial Wallet, identified by its BIP44 change and address index.

operationId: GetEmbeddedWalletPublicKeyInfoForAddress

Options

• :compressed (boolean/0) - When true, returns the public key in compressed format

@spec get_asset_public_key_info_alt(
  String.t(),
  String.t(),
  String.t(),
  non_neg_integer(),
  non_neg_integer(),
  keyword()
) :: map()

Get the public key of an asset using the legacy internal path format.

operationId: getPublicKeyInfoForAddressNcw

This endpoint is marked x-internal in the specification. Prefer get_asset_public_key_info/6 for all new integrations.

Options

• :compressed (boolean/0) - When true, returns the public key in compressed format

@spec get_device(String.t(), String.t()) :: map()

Get a specific device registered to a specific Non-Custodial Wallet.

operationId: GetEmbeddedWalletDevice

@spec get_device_setup_status(String.t(), String.t()) :: map()

Get the key setup state of a specific device under a specific Non-Custodial Wallet.

operationId: GetEmbeddedWalletDeviceSetupState

@spec get_latest_backup(String.t()) :: map()

Get wallet latest backup details, including the deviceId and backup time.

operationId: GetEmbeddedWalletLatestBackup

@spec get_public_key_info(
  String.t(),
  keyword()
) :: map()

Get the public key information based on derivation path and signing algorithm within a Non-Custodial Wallet.

operationId: getPublicKeyInfoNcw

Options

• :derivationPath (String.t/0) - Required. Full BIP44 derivation path as a JSON-stringified integer array (first element must be 44)

• :algorithm - Required. Signing algorithm: MPC_ECDSA_SECP256K1, MPC_ECDSA_SECP256R1, or MPC_EDDSA_ED25519

• :compressed (boolean/0) - When true, returns the public key in compressed format

@spec get_supported_assets(keyword()) :: map()

Retrieve all available supported assets for Non-Custodial Wallets.

operationId: GetEmbeddedWalletSupportedAssets

Options

• :onlyBaseAssets (boolean/0) - When true, only base assets are returned The default value is true.

• :pageCursor (String.t/0) - Cursor to the next page of results

• :pageSize (integer/0) - Number of items per page (max 400) The default value is 200.

• :order - Sort direction: :asc or :desc The default value is :asc.

@spec get_wallet(String.t()) :: map()

Get a Non-Custodial Wallet by its ID.

operationId: GetEmbeddedWallet

@spec get_wallet_setup_status(String.t()) :: map()

Get the key setup state for a specific Non-Custodial Wallet, including required algorithms and device setup status.

operationId: getEmbeddedWalletSetupStatus

@spec list_assets(String.t(), String.t(), keyword()) :: map()

Retrieve assets for a specific account under a specific Non-Custodial Wallet.

operationId: getEmbeddedWalletAssets

Options

• :sort - Field to sort by: :assetId or :createdAt The default value is :assetId.

• :pageCursor (String.t/0) - Cursor to the next page of results

• :pageSize (integer/0) - Number of items per page (max 400) The default value is 200.

• :order - Sort direction: :asc or :desc The default value is :asc.

@spec list_devices(
  String.t(),
  keyword()
) :: map()

Get a paginated list of registered devices for a specific Non-Custodial Wallet.

operationId: getEmbeddedWalletDevicesPaginated

Options

• :sort - Field to sort by The default value is :createdAt.

• :pageCursor (String.t/0) - Cursor to the next page of results

• :pageSize (integer/0) - Number of items per page (max 400) The default value is 200.

• :order - Sort direction: :asc or :desc The default value is :asc.

@spec list_wallets(keyword()) :: map()

List all Non-Custodial Wallets.

operationId: GetEmbeddedWallets

Options

• :sort - Field to sort by The default value is :createdAt.

• :enabled (boolean/0) - When set, filters wallets by their enabled/disabled status

• :pageCursor (String.t/0) - Cursor to the next page of results

• :pageSize (integer/0) - Number of items per page (max 400) The default value is 200.

• :order - Sort direction: :asc or :desc The default value is :asc.

@spec refresh_asset_balance(String.t(), String.t(), String.t()) :: map()

Refresh the balance of a specific asset under a specific account within a Non-Custodial Wallet.

operationId: RefreshEmbeddedWalletAssetBalance

@spec update_device_status(String.t(), String.t(), keyword(), String.t()) :: map()

Update the enabled/disabled status of a specific device for a Non-Custodial Wallet.

operationId: updateEmbeddedWalletDeviceStatus

Options

• :enabled (boolean/0) - Required. Whether the device should be enabled (true) or disabled (false)

@spec update_wallet_status(String.t(), keyword(), String.t()) :: map()

Update the enabled/disabled status of a specific Non-Custodial Wallet.

operationId: updateEmbeddedWalletStatus

Options

• :enabled (boolean/0) - Required. Whether the wallet should be enabled (true) or disabled (false)