Skip to main content
POST
Signup

Body

application/json

Request payload for signup.

Request payload for signup.

emailAddress
string<email>
required

Email address of the account.

Required string length: 5 - 254
password
string
required

Password of the account.

Required string length: 8 - 128
username
string
required

Public account handle, unique across all accounts.

Required string length: 3 - 32
Pattern: ^[a-z0-9]+(?:-[a-z0-9]+)*$
displayName
string

Optional display name of the account.

Required string length: 2 - 32
rememberMe
boolean
default:false

Whether to remember the device for extended session. Defaults to false.

Response

Response returned after successful authentication (login/signup).

Response returned after successful authentication (login/signup).

apiToken
string
required

The JWT API token for authentication.

expiresAt
string<date-time>
required

Timestamp when the token expires.

issuedAt
string<date-time>
required

Timestamp when the token was issued.

username
string
required

Handle of the authenticated account.

Required string length: 3 - 32
Pattern: ^[a-z0-9]+(?:-[a-z0-9]+)*$