Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.taxmaxi.com/llms.txt

Use this file to discover all available pages before exploring further.

To create a local account, send your email address, a password of at least eight characters, and an optional display name to POST /auth/register. A verification email is sent immediately, and the response tells you which frontend route to navigate to so your user can enter the code. You must verify your email before you can log in — any login attempt with an unverified address returns a 403 EmailVerificationRequiredError.

​
POST /auth/register

Creates a new local user account and starts the email verification flow.

​
Request body

​
email
string
required
The email address for the new account. Must be a valid email format and not already registered.
​
password
string
required
The account password. Must be at least 8 characters. If the password does not meet strength requirements, the response includes a list of unmet requirements.
​
displayName
string
An optional display name shown in the user profile. Must be a non-empty string if provided.

​
Response — 201 Created

​
email
string
required
The email address of the newly created account.
​
redirectTo
string
required
The frontend route to navigate to so the user can complete email verification (e.g. /verify-email).

​
Errors

StatusErrorDescription
400AuthValidationErrorA required field is missing or has an invalid format. The field property identifies which field failed.
400PasswordWeakErrorThe password does not meet strength requirements. The requirements array lists each unmet rule.
409UserExistsErrorAn account with this email already exists. The email field confirms which address is taken.
curl --request POST \
  --url https://api.taxmaxi.com/auth/register \
  --header 'Content-Type: application/json' \
  --data '{
    "email": "[email protected]",
    "password": "kNmGP3sW_ygVLdcNVbxU",
    "displayName": "Max Mustermann"
  }'
Response
{
  "email": "[email protected]",
  "redirectTo": "/verify-email"
}

​
POST /auth/verify-email

Submits the verification code sent to the user’s email address. On success, the account is marked as verified and a redirectTo route is returned so you can navigate the user to their next step (e.g. the login page or dashboard).

​
Request body

​
code
string
required
The verification code from the email. Codes are single-use and expire after a short window.

​
Response — 200 OK

​
redirectTo
string
required
The frontend route to navigate to after verification succeeds (e.g. /home).

​
Errors

StatusErrorDescription
400EmailVerificationFlowMissingErrorThe verification session is missing or expired. The user must restart registration.
400EmailVerificationCodeInvalidErrorThe submitted code does not match the expected value.
400EmailVerificationCodeExpiredErrorThe code was valid but has expired. Request a new one with POST /auth/resend-verification.
curl --request POST \
  --url https://api.taxmaxi.com/auth/verify-email \
  --header 'Content-Type: application/json' \
  --data '{
    "code": "847291"
  }'

​
POST /auth/resend-verification

Replaces the pending verification code and resends the email. Use this when a user did not receive the original email or the code has expired. This endpoint requires no request body — the verification session is tracked server-side. If the session is missing or expired, the user must restart registration.

​
Response — 200 OK

​
email
string
required
The email address a new verification code was sent to.
​
redirectTo
string
required
The frontend route to continue the verification flow (e.g. /verify-email).

​
Errors

StatusErrorDescription
400EmailVerificationFlowMissingErrorNo active verification session found. The user must restart registration.
curl --request POST \
  --url https://api.taxmaxi.com/auth/resend-verification