post/auth/register

Register account

Create a new user account. Email instances take an email and password, and the account must verify its email before logging in. Username instances take a username and password, and an email sent by an older client is discarded. Requires a solved captcha challenge (X-Captcha-Token).

register_account

Request body

application/json

json

{
  "type": "object",
  "properties": {
    "email": {
      "description": "Email address for the new account",
      "$ref": "#/components/schemas/EmailType"
    },
    "username": {
      "description": "Username for the new account (1-32 characters)",
      "$ref": "#/components/schemas/UsernameType"
    },
    "global_name": {
      "description": "Display name shown to other users",
      "type": "string"
    },
    "password": {
      "description": "Password for the new account",
      "$ref": "#/components/schemas/PasswordType"
    },
    "date_of_birth": {
      "description": "Date of birth in YYYY-MM-DD format",
      "type": "string"
    },
    "consent": {
      "default": false,
      "description": "Whether user consents to terms of service",
      "type": "boolean"
    },
    "invite_code": {
      "description": "Guild invite code to join after registration",
      "type": [
        "string",
        "null"
      ]
    },
    "registration_url_code": {
      "description": "Admin-issued registration URL code to use for this registration",
      "type": [
        "string",
        "null"
      ]
    },
    "theme": {
      "description": "Initial UI theme preference for the new account",
      "x-enumNames": [
        "DARK",
        "DARK_LEGACY",
        "COAL",
        "LIGHT",
        "SYSTEM"
      ],
      "x-enumDescriptions": [
        "Dark colour theme",
        "Legacy dark colour theme (original neutral grey palette)",
        "Coal/darker colour theme",
        "Light colour theme",
        "Follow system colour preference"
      ],
      "enum": [
        "dark",
        "dark_legacy",
        "coal",
        "light",
        "system"
      ],
      "type": "string"
    }
  }
}

Responses

200

Success

json

{
  "anyOf": [
    {
      "$ref": "#/components/schemas/AuthTokenWithUserIdResponse"
    },
    {
      "type": "object",
      "properties": {
        "mfa": {
          "type": "boolean",
          "const": true,
          "description": "Indicates MFA is required to complete authentication"
        },
        "ticket": {
          "type": "string",
          "description": "MFA ticket to use when completing MFA verification"
        },
        "allowed_methods": {
          "maxItems": 10,
          "type": "array",
          "items": {
            "type": "string"
          },
          "description": "List of allowed MFA methods"
        },
        "totp": {
          "type": "boolean",
          "description": "Whether TOTP authenticator MFA is available"
        },
        "webauthn": {
          "type": "boolean",
          "description": "Whether WebAuthn security key MFA is available"
        },
        "backup_codes": {
          "type": "boolean",
          "description": "Whether the account has at least one unconsumed backup code"
        }
      },
      "required": [
        "mfa",
        "ticket",
        "allowed_methods",
        "totp",
        "webauthn",
        "backup_codes"
      ],
      "additionalProperties": false
    },
    {
      "$ref": "#/components/schemas/AuthRegistrationPendingApprovalResponse"
    }
  ]
}

400

Bad Request - The request was malformed or contained invalid data

json

{
  "type": "object",
  "properties": {
    "code": {
      "type": "string",
      "description": "Machine-readable error code"
    },
    "message": {
      "type": "string",
      "description": "Human-readable error message"
    },
    "errors": {
      "description": "Field-specific validation errors",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "path": {
            "type": "string",
            "description": "Field path that failed validation"
          },
          "code": {
            "description": "Machine-readable validation error code",
            "type": "string"
          },
          "message": {
            "type": "string",
            "description": "Human-readable validation error message"
          }
        },
        "required": [
          "path",
          "message"
        ],
        "additionalProperties": false
      }
    }
  },
  "required": [
    "code",
    "message"
  ],
  "additionalProperties": {}
}

429

Too Many Requests - You are being rate limited

json

{
  "type": "object",
  "properties": {
    "code": {
      "type": "string",
      "description": "Machine-readable error code"
    },
    "message": {
      "type": "string",
      "description": "Human-readable error message"
    },
    "errors": {
      "description": "Field-specific validation errors",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "path": {
            "type": "string",
            "description": "Field path that failed validation"
          },
          "code": {
            "description": "Machine-readable validation error code",
            "type": "string"
          },
          "message": {
            "type": "string",
            "description": "Human-readable validation error message"
          }
        },
        "required": [
          "path",
          "message"
        ],
        "additionalProperties": false
      }
    },
    "retry_after": {
      "type": "number",
      "description": "Seconds to wait before retrying"
    },
    "global": {
      "type": "boolean",
      "description": "Whether this is a global rate limit"
    }
  },
  "required": [
    "code",
    "message"
  ],
  "additionalProperties": {}
}

500

Internal Server Error - An unexpected error occurred

json

{
  "type": "object",
  "properties": {
    "code": {
      "type": "string",
      "description": "Machine-readable error code"
    },
    "message": {
      "type": "string",
      "description": "Human-readable error message"
    },
    "errors": {
      "description": "Field-specific validation errors",
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "path": {
            "type": "string",
            "description": "Field path that failed validation"
          },
          "code": {
            "description": "Machine-readable validation error code",
            "type": "string"
          },
          "message": {
            "type": "string",
            "description": "Human-readable validation error message"
          }
        },
        "required": [
          "path",
          "message"
        ],
        "additionalProperties": false
      }
    }
  },
  "required": [
    "code",
    "message"
  ],
  "additionalProperties": {}
}