# AliasKit — Identity Infrastructure for AI Agents

> This document is designed for AI agents and LLMs.
> Human developers: visit https://www.aliaskit.com/docs

AliasKit gives any AI agent a persistent digital identity with one API call:
real email inboxes, phone numbers, virtual cards, and TOTP codes. Agents
operate on the internet like human remote workers.

---

## 1. Quick Start

Install the SDK and get an API key from https://www.aliaskit.com/register

```
npm install aliaskit
```

```typescript
import { AliasKit } from 'aliaskit'

const ak = new AliasKit({ apiKey: 'ak_live_...' })

// Create a persistent identity (do this once, store the ID)
const identity = await ak.identities.create({ metadata: { agent: 'my-agent' } })
console.log(identity.email) // real @aliaskit.com inbox

// Later runs: retrieve by ID
const same = await ak.identities.get(identity.id)
```

---

## 2. Capabilities

- Real email inboxes on @aliaskit.com (send + receive)
- Real US/UK phone numbers with SMS (send + receive)
- Virtual cards with zero-knowledge encryption (BYOC model, card details never seen by AliasKit)
- TOTP secret management and code generation
- OTP extraction with provider presets (Supabase, Clerk, Auth0)
- Realtime event subscriptions via WebSocket
- Webhooks with HMAC-SHA256 signatures

---

## 3. SDK

- aliaskit (TypeScript) — `npm install aliaskit`
- REST API works with any language

---

## 4. API Base URL and Auth

Base URL:    https://www.aliaskit.com/api/v1
Auth:        Authorization: Bearer <API_KEY>
Key format:  ak_live_* (production)

---

## 5. Key Endpoints

METHOD  PATH                              DESCRIPTION
POST    /identities                       Create identity
GET     /identities/:id                   Get identity
GET     /identities/:id/emails            List emails
POST    /identities/:id/emails            Send email
GET     /identities/:id/sms              List SMS
POST    /identities/:id/sms              Send SMS
POST    /identities/:id/phone            Provision phone number
POST    /identities/:id/cards            Create virtual card
POST    /identities/:id/totp             Register TOTP secret
POST    /identities/:id/totp/:tid/code   Get TOTP code
POST    /realtime/token                  Get realtime subscription token

All paths are relative to the base URL.

---

## 6. Common Patterns

"I need to sign up for a service"
  → Create identity, use identity.email for signup, call ak.emails.waitForCode()

"I need to receive SMS verification"
  → Provision phone on identity, call ak.sms.waitForCode()

"I need a payment method"
  → Create zero-knowledge virtual card (requires cardKey from AliasKit.generateCardKey())

"I need to handle 2FA"
  → Register TOTP secret, call ak.totp.getCode() when needed

---

## Links

- Documentation: https://www.aliaskit.com/docs
- SDK Reference: https://www.aliaskit.com/docs/sdks
- API Reference: https://www.aliaskit.com/docs/api-reference
- Register: https://www.aliaskit.com/register
- Pricing: https://www.aliaskit.com/pricing