Keyspace
A keyspace is the container for related keys. You might have one per product, one per such as production and staging, or one per pricing tier. Every key belongs to exactly one keyspace, and you name the keyspace by its API ID (api_...) whenever you create a key.
A keyspace sets defaults for new keys (a prefix and a key length). It can also have delete protection and an IP allow list that applies to every key in it. It has a second identifier, the Keyspace ID (ks_...), which analytics and the customer portal use. You’ll find both IDs on the keyspace’s settings page. Keyspaces explains when to create more than one.
Key
A key is a random string, with an optional prefix, that you give to a user of your application. Unkey stores only a hash of the key, never the key itself, unless you turn on recoverable keys. On every request, your backend sends the key tokeys.verifyKey and Unkey runs the checks set on it.
Every check is optional: whether the key is enabled, when it expires, how many credits it has left, which rate limits apply, and which permissions and roles it has. A key can also carry JSON metadata that comes back on every verification, so your backend can read a plan tier or feature flag without a database lookup. Creating keys lists each field with its bounds.
Identity
An identity is one user, organization, or service account in your system, named by anexternalId you choose. Keys linked to an identity share its rate limits and metadata. Pass externalId when you create a key, and Unkey creates the identity if needed and links the key, so most apps never call the identity endpoints directly. Identities covers shared rate limits and metadata in detail.
Root key
A root key authenticates you, not your users. Every call toapi.unkey.com sends a root key in the Authorization: Bearer header, and its permissions decide which calls succeed. Create root keys in the dashboard under Settings > Root Keys. Permissions such as api.*.create_key or api.<api_id>.verify_key apply to every keyspace or to one. See Root keys for how permissions are granted and rotated.
How the objects relate
Next steps
Issue and verify your first key
Put the four objects to work in a few minutes.
Keyspaces
Decide how many keyspaces you need and what they store.