---
title: "POST /v1/auth/register"
method: POST
path: "/v1/auth/register"
tags: ["Auth"]
---

# POST /v1/auth/register

`POST /v1/auth/register`

## Request

- Base URL: `https://api.tokenbooks.io` (the document declares no server; this is the origin it was published from)
- URL: `https://api.tokenbooks.io/v1/auth/register`
- Auth: none declared

## Request body

- RegistrationRequestDto
  - `email` string, email, required: User email address
  - `password` string, required: User password (minimum 8 characters)
  - `workspace` object, required
    - `name` string, required: Workspace name
    - `slug` string: Workspace slug (auto-generated if not supplied

## Response `201`

- union
  - object
    - `status` 'verification-required', required: Check the address for an email verification link
  - object
    - `status` 'registered', required
    - `user` object, required
      - `id` string, required: User ID
      - `email` string, email, required: User email
    - `workspace` object, required
      - `id` string, required: Workspace ID
      - `name` string, required: Workspace name
      - `slug` string, required: Workspace slug
    - `apiKey` string, required: Workspace-scoped API key (store securely!)

## Other responses

- `429`

---

[API](https://skmtc.dev/tokenbooks/apis/tokenbooks-public-api.md) · [All operations](https://skmtc.dev/tokenbooks/apis/tokenbooks-public-api/llms.txt) · [OpenAPI document](https://skmtc.dev/tokenbooks/apis/tokenbooks-public-api/revisions/634c5114c75f?raw)