> ## Documentation Index
> Fetch the complete documentation index at: https://docs.sumvin.com/llms.txt
> Use this file to discover all available pages before exploring further.

# TypeScript SDK

> What the Sumvin TypeScript SDK does, the two jobs it covers, and who can use each part today.

export const waitlists = {
  earlyAccess: "",
  payments: "",
  openBanking: "",
  developers: "",
  verifiers: ""
};

<Note>
  **Private preview:** this is rolling out and may not be available on your account yet.{waitlists.earlyAccess ? <> <a href={waitlists.earlyAccess}>Request early access →</a></> : null}
</Note>

`@sumvin/sdk` is the TypeScript SDK for the Sumvin API. It gives you every API operation as a typed function, plus a small layer on top: authentication, one way to handle errors, and a reader for the limits a [Stamped Mandate](/concepts/stamped-mandates) carries.

The SDK is open source at [github.com/Sumvin/sdk-ts](https://github.com/Sumvin/sdk-ts) and published on npm as [`@sumvin/sdk`](https://www.npmjs.com/package/@sumvin/sdk).

## Two jobs

<Columns cols={2}>
  <Card title="Act for a person" icon="bot" href="/sdk/agents/sign-in">
    Sign in as a person and read or revoke their Stamped Mandates and connected agents.
  </Card>

  <Card title="Check a mandate" icon="shield-check" href="/sdk/verify/quickstart">
    An agent shows you a Stamped Mandate. Check it offline and online before you act on it.
  </Card>
</Columns>

## Who can use what today

| Part                 | Who can use it today                                                                                                                                                                                                                                                                                                                                                                               |
| -------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| **Act for a person** | Sumvin's own apps and approved clients. Personal access tokens are not yet open to third-party apps. If you are building your own agent, connect it through the [MCP connector](/get-started/connect) or the [CLI](/get-started/cli/install) instead.                                                                                                                                              |
| **Check a mandate**  | Any site can check a token addressed to its own website, with no key. Checks addressed to an organisation need a key from the developer dashboard, which is by invitation during the preview. These checks are plain HTTP calls and a standard JWT library; the SDK has no verification function yet. The SDK's [ceiling reader](/sdk/verify/reading-scopes) helps you read what a mandate allows. |

## Next

<Columns cols={2}>
  <Card title="Install" icon="download" href="/sdk/install">
    Add the package and check your runtime.
  </Card>

  <Card title="Verifier quickstart" icon="shield-check" href="/sdk/verify/quickstart">
    Get a key, then check a mandate offline and online.
  </Card>
</Columns>