Skip to main content

Introduction

welcome

Welcome to the Turnkey docs!​

Start here for a quick primer on our high-level product structure to orient you to the rest of the documentation. If you’d rather jump straight into the quickstart, head here. Or, join our Slack group here to get support with your integration, share product feedback, and connect with other crypto builders.

About Turnkey​

Turnkey is crypto private key infrastructure that lets developers securely generate private keys and sign transactions via simple APIs.

How it works​

At a structural level, a Turnkey Organization is comprised of a few core resources:

  • Users: Humans or machines with access to an Organization
  • Policies: Rules defining which users can take which actions within an Organization
  • Private Keys: Crypto private keys, used to derive addresses and sign transactions
  • Wallets: A collection of crypto private keys that share a common seed
  • Credentials: Used to verify Users - WebAuthn authenticators for human Users and API keys for API Users

resources

Turnkey enables two main types of actions via our REST API:

  • Change or retrieve Organization data
  • Sign transactions and raw payloads with crypto private keys

There is no predefined relationship between any of the resources in your Turnkey Organization. Rather, your Policies determine which users can take which actions, under which conditions.

For example, an automated API request to sign a transaction will first be run against all of your Policies to ensure that API user has permission to sign that particular transaction with the specified Private Key. Turnkey’s signer will complete the request only if the Policy Engine approves the transaction.

All secure workloads, including key management and transaction signing, are managed by Turnkey within our secure infrastructure. These Private Keys can only be used via your Turnkey credentials and no private key material is ever exposed, to Turnkey or to your team.

Where to head next​

Quickstart guide: Walk through setup of the Turnkey API and Platform, create a crypto Private Key, and sign your first transaction via command line.

Examples: Turnkey’s flexible infrastructure means there’s a lot you can build. Check out a few of our own examples to get a picture of what’s possible.

Security architecture: Turnkey’s unique security architecture is the foundation of our product. Dive in to understand how we secure your keys.