!(function () {
  var e = [
    "identify",
    "page",
    "startAutoPage",
    "stopAutoPage",
    "startAutoIdentify",
    "stopAutoIdentify",
  ];
  function t(o) {
    return Object.assign(
      [],
      e.reduce(function (r, n) {
        return (
          (r[n] = function () {
            return o.push([n, [].slice.call(arguments)]), o;
          }),
          r
        );
      }, {})
    );
  }
  window.unify || (window.unify = t(window.unify)),
    window.unifyBrowser || (window.unifyBrowser = t(window.unifyBrowser));
  var n = document.createElement("script");
  (n.async = !0),
    n.setAttribute(
      "src",
      "https://tag.unifyintent.com/v1/7Kk92osLC7vgqrstznftZA/script.js"
    ),
    n.setAttribute(
      "data-api-key",
      "wk_gHe63XaT_7Ayfg866Ci5SHWgeNTkqUjxYGdKDUfT7"
    ),
    n.setAttribute("id", "unifytag"),
    (document.body || document.head).appendChild(n);
})();


Overview

Code Examples

Turnkey

Welcome to Turnkey! To make the most out of Turnkey's wallet infrastructure, we've compiled a list of helpful resources for you below.

Welcome

Getting started with Turnkey

Introduction

Embedded Wallets

Turnkey has built a new model for private key management that utilizes secure enclaves. All transactions are signed within an enclave and private keys are never exposed to Turnkey, your software, or your team. Turnkey’s role is similar to that of a safety deposit box operator — Turnkey secures and provides access to the safety deposit boxes, but our system requires cryptographic proof of ownership to take any action with the keys held within.

Integrating Embedded Wallets

Email auth is a powerful feature to couple with [sub-organizations](/concepts/sub-organizations) for your users. This approach empowers your users to authenticate their Turnkey in a simple way (via email!), while minimizing your involvement: we engineered this feature to ensure your organization is unable to take over sub-organizations even if it wanted to.

Email Authentication

Email recovery shines if you are leveraging [sub-organizations](/concepts/sub-organizations) to create embedded wallets for your users. This allows your users to recover their Turnkey account if something goes wrong with their passkeys, and keeps you out of the loop: we engineered this feature to ensure your organization is unable to take over sub-organizations even if it wanted to.

Email Recovery

Turnkey offers flexible infrastructure to create and manage keys. These keys can be used as a signer inside of an [Account Abstraction wallet](https://www.erc4337.io/), and we've partnered with [Alchemy](https://www.alchemy.com/) and [ZeroDev](https://zerodev.app/) to integrate in a few lines of code.

Account Abstraction Wallets

Turnkey offers a suite of react components to create embedded wallets without having to setup a backend by using Next.js [server actions](https://nextjs.org/docs/app/building-your-application/data-fetching/server-actions-and-mutations) and associated directives. Each component uses the **authIframeClient** from [@turnkey/sdk-react](https://www.npmjs.com/package/@turnkey/sdk-react).

Embedded Wallet Kit (EWK)

Gasless Solana Transactions

How to Integrate Gasless Transactions On Solana With Turnkey

Signing Automation

Learn how to set up and use co-signing (multi-sig) wallets with Turnkey.

Co-signing Transactions

Turnkey provides a variety of client and server SDKs which simplify interacting with Turnkey's API. The SDKs offer methods, utilities, and helper functions to quickly implement features and perform common workflows.

SDK Reference

JavaScript Browser

The [`@turnkey/sdk-server`](https://www.npmjs.com/package/@turnkey/sdk-server) package exposes functionality that lets developers build server-side functionality for applications that interact with the Turnkey API.

JavaScript Server

React

This documentation contains guides for using Turnkey's React Native compatible [JavaScript packages](https://github.com/tkhq/sdk/tree/main/packages).

React Native

Turnkey offers native tooling for interacting with the API using Golang. See [https://github.com/tkhq/go-sdk](https://github.com/tkhq/go-sdk) for more details.

Golang

Turnkey offers native tooling for interacting with the API using Rust. See [https://github.com/tkhq/rust-sdk](https://github.com/tkhq/rust-sdk) for more details.

Rust

Turnkey offers native tooling for interacting with the API using Ruby. See [https://github.com/tkhq/ruby-sdk](https://github.com/tkhq/ruby-sdk) for more details.

Ruby

This quickstart will guide you through Turnkey’s onboarding, adding an API key, creating a wallet, and signing your first Ethereum transaction.

Command Line

Using the CLI

This documentation contains guides for using the Flutter SDK.

Flutter

This guide aims to cover the process for migrating from lower-level Turnkey SDK (i.e. `@turnkey/{ http, api-key-stamper, webauthn-stamper, iframe-stamper }`) libraries, to our more recent abstractions: `@turnkey/{ sdk-browser, sdk-server, sdk-react }`

Migration Path

Review our [API Introduction](/developer-reference/api-overview/intro) to get started.

API Reference

Activities are requests to securely execute a workload in Turnkey.

Activities

Create API Keys

Create Authenticators to authenticate requests to Turnkey

Create Authenticators

Create Invitations to join an existing Organization

Create Invitations

Creates Oauth providers for a specified user - BETA

Create Oauth Providers

Create Policies

Create Policy

Create a private key tag and add it to private keys.

Create Private Key Tag

Create Private Keys

Create a read only session for a user (valid for 1 hour)

Create Read Only Session

Create Read Write Session

Create Sub-Organization

Create User Tag

Create Users

Create Wallet

Derive additional addresses using an existing wallet

Create Wallet Accounts

Delete API Keys

Delete Authenticators

Delete Invitation

Removes Oauth providers for a specified user - BETA

Delete Oauth Providers

Delete Policy

Delete Private Key Tags within an Organization

Delete Private Key Tags

Delete Private Keys

Delete Sub Organization

Delete User Tags

Delete Users

Delete Wallets

Export Private Key

Export Wallet

Export Wallet Account

Import Private Key

Import Wallet

Init Email Recovery

Init Import Private Key

Init Import Wallet

Init OTP auth

Authenticate a user with an Oidc token (Oauth) - BETA

Oauth

Authenticate a user with an OTP code sent via email or SMS

OTP auth

Perform Email Auth

Completes the process of recovering a user by adding an authenticator

Recover a user

Removes an organization feature. This activity must be approved by the current root quorum.

Remove Organization Feature

Sets an organization feature. This activity must be approved by the current root quorum.

Set Organization Feature

Sign Raw Payload

Sign multiple raw payloads with the same signing parameters

Sign Raw Payloads

Sign Transaction

Update Policy

Update human-readable name or associated private keys. Note that this activity is atomic: all of the updates will succeed at once, or all of them will fail.

Update Private Key Tag

Set the threshold and members of the root quorum. This activity must be approved by the current root quorum.

Update Root Quorum

Update a User in an existing Organization

Update User

Update human-readable name or associated users. Note that this activity is atomic: all of the updates will succeed at once, or all of them will fail.

Update User Tag

Update Wallet

Queries are read requests to Turnkey's API. They allow you to retrieve data about your organization and its resources.

Queries

Get Activity

Get API key

Get API keys

Get Authenticator

Get details about authenticators for a user

Get Authenticators

Get quorum settings and features for an organization

Get Configs

Get details about Oauth providers for a user

Get Oauth providers

Get Policy

Get Private Key

Get all suborg IDs associated given a parent org ID and an optional filter.

Get Suborgs

Get User

Get all email or phone verified suborg IDs associated given a parent org ID.

Get Verified Suborgs

Get Wallet

Get Wallet Account

List all Activities within an Organization

List Activities

List Policies

List all Private Key Tags within an Organization

List Private Key Tags

List all Private Keys within an Organization

List Private Keys

List all User Tags within an Organization

List User Tags

List Users

List Wallets

List Wallets Accounts

Get basic information about your current API or WebAuthN user and their organization. Affords Sub-Organization look ups via Parent Organization for WebAuthN or API key users.

Who am I?

Welcome to the home of your new documentation

Start building awesome documentation in under 5 minutes

Quickstart

Development

Text, title, and styling in standard markdown

Markdown Syntax

Code Blocks

Add image, video, and other HTML elements

Images and Embeds

Mintlify gives you complete control over the look and feel of your documentation using the mint.json file

Global Settings

The navigation field in mint.json defines the pages that go in the navigation menu

Navigation

Reusable, custom snippets to keep content in sync

Reusable Snippets

Example section for showcasing API endpoints

Returns all plants from the system that the user has access to

Get Plants

Create Plant

Deletes a single plant based on the ID supplied

Embedded Wallets

Signing Automation

Code Examples

Create a Sub-Org with a Passkey User

Authenticate a User with a Passkey Credential

Create a User Passkey Session

Create a User with Email Only

Authenticate a User with Email

Recover a User with Email

Add an Additional Passkey

Authenticate a User with an Ethereum Wallet

Signing Transactions

Import Wallet or Private Key

Export Wallet or Private Key