Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.0xkey.io/llms.txt

Use this file to discover all available pages before exploring further.

​
Overview

The official Go module github.com/0xkey-io/sdk-go provides:
  • Generated API client (go-swagger) for 0xkey activities
  • API key generation and request signing (pkg/apikey)
  • HPKE enclave encryption for OTP and import/export (pkg/enclave_encrypt)
  • Session JWT verification (pkg/crypto)
  • Local key storage (pkg/store/local)
Use it for server-side automation: Company Wallets, delegated access, OTP backends, and batch signing.

​
Prerequisites

  1. Go 1.21+
  2. A 0xkey organization (Quickstart)
  3. An API keypair registered to that organization (private key stays on your machine)
Generate and register keys with the 0xkey CLI or the examples/apikey helper.

​
Installation

go get github.com/0xkey-io/sdk-go@latest
Current release: v0.1.0 on pkg.go.dev.

​
Configure API keys

The SDK reads keys from ~/.config/0xkey/keys/ when you pass sdk.WithAPIKeyName("default"). After creating a key with the CLI, ensure the key name matches what you pass to WithAPIKeyName. Alternatively, load a key programmatically: 
import "github.com/0xkey-io/sdk-go/pkg/apikey"

key, err := apikey.FromZeroXKeyPrivateKey(
	os.Getenv("OXKEY_API_PRIVATE_KEY"),
	apikey.SchemeP256,
)

​
First request (Whoami)

package main

import (
	"fmt"
	"log"

	"github.com/0xkey-io/sdk-go"
	"github.com/0xkey-io/sdk-go/pkg/api/client/sessions"
	"github.com/0xkey-io/sdk-go/pkg/api/models"
)

func main() {
	client, err := sdk.New(sdk.WithAPIKeyName("default"))
	if err != nil {
		log.Fatal(err)
	}

	params := sessions.NewGetWhoamiParams().WithBody(&models.GetWhoamiRequest{
		OrganizationID: client.DefaultOrganization(),
	})

	resp, err := client.V0().Sessions.GetWhoami(params, client.Authenticator)
	if err != nil {
		log.Fatal(err)
	}

	fmt.Println("UserID:", *resp.Payload.UserID)
}
Runnable copy: examples/whoami.

​
Custom API host

For staging or local-gateway: 
import "github.com/0xkey-io/sdk-go/pkg/api/client"

cfg := client.DefaultTransportConfig()
cfg.Host = "api.0xkey.com" // local-gateway
cfg.Schemes = []string{"https"}

c, err := sdk.New(
	sdk.WithAPIKeyName("default"),
	sdk.WithTransportConfig(*cfg),
)
Local HTTP (no TLS): 
cfg.Host = "localhost:8080"
cfg.Schemes = []string{"http"}
Enclave-backed flows (email OTP) also need signer/notarizer public keys — see examples/email_otp.

​
Sub-packages

PackagePurpose
pkg/apikeyP-256 / Ed25519 key generation and stamps
pkg/enclave_encryptHPKE encrypt to Signer enclave (OTP, import/export)
pkg/cryptoSession JWT and OTP token verification
pkg/encryptionkeyEncryption key helpers
pkg/proofsNitro attestation verification
pkg/store/localFilesystem key storage
pkg/api/clientLow-level generated client
Import sub-packages independently when you do not need the full sdk.New() wrapper.

​
Example workflows

ExamplePathDescription
Whoamiexamples/whoami/Verify API key and org
Email OTPexamples/email_otp/Full backend OTP + HPKE flow
Delegated accessexamples/delegated_access/Sub-org + scoped policy
Sign transactionexamples/signing/sign_transaction/Activity signing
Sign raw payloadexamples/signing/sign_raw_payload/Message signing
Ethereum txsexamples/transaction_management/ethereum/EVM transaction management
Solana txsexamples/transaction_management/solana/SVM transaction management
go-ethereumexamples/go-ethereum/BindSigner integration
Wallet CRUDexamples/wallets/Create, import, export wallets
API key genexamples/apikey/Programmatic key creation

​
Error handling

API errors can be inspected as *runtime.APIError: 
import (
	"io"
	"github.com/go-openapi/runtime"
)

if err != nil {
	if apiErr, ok := err.(*runtime.APIError); ok && apiErr.Response != nil {
		b, _ := io.ReadAll(apiErr.Response.Body())
		log.Printf("0xkey API body: %s", string(b))
	}
	return err
}
Custom logging: sdk.WithLogger(yourLogger) — see Go SDK overview.

​
Next steps

Delegated access

Policy-scoped backend signing

TypeScript server

Node.js equivalent of server automation

API stamps

How requests are authenticated

pkg.go.dev

Generated API reference