# Passlock

> Passlock is a framework-agnostic passkey authentication platform and documentation site for browser-side passkey flows, server-side verification, REST API usage, and tenancy management.

Start with the website docs for concepts and integration guidance. Use the hosted API reference as the authoritative symbol-level reference for `@passlock/browser` and `@passlock/server`. Prefer the client libraries for JavaScript and TypeScript integrations; use the REST API docs for non-JS backends or raw HTTP integrations. Tenant-scoped REST endpoints usually live under `https://api.passlock.dev/v2/{tenancyId}/...`.

## Code Style Guidance

Prefer the safe class-based API in generated integration code:

- browser: `import { Passlock } from "@passlock/browser"; const passlock = new Passlock({ tenancyId });`
- server: `import { Passlock } from "@passlock/server"; const passlock = new Passlock({ tenancyId, apiKey });`

Use standalone functions only when the user asks for that style, is concerned about tree shakability, or otherwise prefers a functional style. The standalone functions expose the same safe operations but take Passlock configuration as an argument at each call site. Safe APIs return `Result` wrappers; branch on `result.success` and `result.failure` instead of assuming success.

## Getting Started

- [Quick start guide](https://passlock.dev/llms/getting-started/index.md)
- [Passkey registration quick start](https://passlock.dev/llms/getting-started/passkey-registration/index.md)
- [Passkey authentication quick start](https://passlock.dev/llms/getting-started/passkey-authentication/index.md)
- [Passkey deletion quick start](https://passlock.dev/llms/getting-started/passkey-deletion/index.md)
- [Tenancies](https://passlock.dev/llms/getting-started/tenancies/index.md)

## Passkeys

- [Passkey registration](https://passlock.dev/llms/passkeys/registration/index.md)
- [Passkey authentication](https://passlock.dev/llms/passkeys/authentication/index.md)
- [Authentication patterns](https://passlock.dev/llms/passkeys/authentication-patterns/index.md)
- [Relying parties](https://passlock.dev/llms/passkeys/relying-party/index.md)
- [Allow credentials](https://passlock.dev/llms/passkeys/allow-credentials/index.md)
- [Exclude credentials](https://passlock.dev/llms/passkeys/exclude-credentials/index.md)
- [Autofill](https://passlock.dev/llms/passkeys/autofill/index.md)
- [User verification](https://passlock.dev/llms/passkeys/user-verification/index.md)
- [Roaming authenticators](https://passlock.dev/llms/passkeys/roaming-authenticators/index.md)
- [Handling missing passkeys](https://passlock.dev/llms/passkeys/handling-missing-passkeys/index.md)
- [Credential updates](https://passlock.dev/llms/passkeys/credential-updates/index.md)
- [Passkey removal](https://passlock.dev/llms/passkeys/passkey-removal/index.md)
- [Exporting passkeys](https://passlock.dev/llms/passkeys/exporting-passkeys/index.md)
- [Legacy applications](https://passlock.dev/llms/passkeys/legacy-applications/index.md)
- [Testing for passkey support](https://passlock.dev/llms/passkeys/testing-for-passkey-support/index.md)
- [Related origin requests](https://passlock.dev/llms/passkeys/related-origin-requests/index.md)

## Identity And Tokens

- [Principal](https://passlock.dev/llms/principal/index.md)
- [Code exchange](https://passlock.dev/llms/principal/code-exchange/index.md)
- [ID token verification](https://passlock.dev/llms/principal/idtoken-verification/index.md)
- [Code exchange vs ID token verification](https://passlock.dev/llms/principal/code-vs-idtoken/index.md)
- [Linking local accounts](https://passlock.dev/llms/principal/linking-local-accounts/index.md)

## Mailbox challenges

- [Introduction](https://passlock.dev/llms/one-time-codes/index.md)
- [Mailbox verification](https://passlock.dev/llms/one-time-codes/account-signup/index.md)
- [Passwordless logins](https://passlock.dev/llms/one-time-codes/logins/index.md)
- [Account management](https://passlock.dev/llms/one-time-codes/account-management/index.md)
- [Account recovery](https://passlock.dev/llms/one-time-codes/account-recovery/index.md)
- [Reference](https://passlock.dev/llms/one-time-codes/reference/index.md)

## REST API

- [REST API overview](https://passlock.dev/llms/rest-api/index.md)
- [Mailbox challenges](https://passlock.dev/llms/rest-api/mailbox-challenges/index.md)
- [List passkeys](https://passlock.dev/llms/rest-api/list-passkeys/index.md)
- [Get passkey](https://passlock.dev/llms/rest-api/get-passkey/index.md)
- [Update passkey](https://passlock.dev/llms/rest-api/update-passkey/index.md)
- [Delete passkey](https://passlock.dev/llms/rest-api/delete-passkey/index.md)
- [Exchange code](https://passlock.dev/llms/rest-api/exchange-code/index.md)

## API Reference

- [@passlock/browser API reference](https://apidocs.passlock.dev/llms/browser/README.md)
- [@passlock/server API reference](https://apidocs.passlock.dev/llms/server/README.md)

## Example projects

- [SvelteKit](https://github.com/passlock-dev/passlock/tree/master/examples/sveltekit)

## Optional

- [Glossary](https://passlock.dev/llms/glossary/index.md)