githubEdit

post__user_register

POST /user/register

Register User

Register a new user with internal email/password authentication.

This endpoint creates a new user account and organization. The system automatically:

  • Validates email format and uniqueness

  • Checks password complexity requirements

  • Creates an organization based on company domain

  • Assigns a free trial subscription

  • Sends email verification

Password Requirements:

  • Minimum 8 characters

  • Must contain uppercase letter

  • Must contain lowercase letter

  • Must contain number

Email Verification:

  • Verification email sent immediately after registration

  • Verification tokens expire after 24 hours

  • Write operations blocked until email verification

Account Types:

  • Personal: Use isBusiness: false for personal accounts

  • Business: Use isBusiness: true for business accounts with company details

TypeScript Client Library

Code Samples

Body parameter

Parameters

Name
In
Type
Required
Description

body

body

object

true

none

» email

body

string(email)

true

User's email address (must be unique)

» password

body

string

true

Password meeting complexity requirements

» firstName

body

string

true

User's first name

» lastName

body

string

true

User's last name

» companyName

body

string

true

Company or organization name

» companyWebsite

body

string

false

Company website URL (optional for personal accounts)

» isBusiness

body

boolean

true

Whether this is a business account

Example responses

201 Response

Responses

Status
Meaning
Description
Schema

201

User registered successfully

Inline

400

Registration failed

Inline

Response Schema

Status Code 201

Name
Type
Required
Restrictions
Description

» success

boolean

false

none

none

» accessToken

string

false

none

JWT access token for API authentication

» refreshToken

string

false

none

JWT refresh token for token renewal

» tokenId

string

false

none

Internal token identifier

» user

object

false

none

none

»» id

string

false

none

User's unique identifier

»» email

string

false

none

User's email address

»» name

string

false

none

User's display name

»» orgId

string

false

none

Organization identifier

»» image_url

string

false

none

User's profile image URL

Status Code 400

Name
Type
Required
Restrictions
Description

» success

boolean

false

none

none

» error_code

string

false

none

Specific error code

» message

string

false

none

Human-readable error message

Enumerated Values

Property
Value

error_code

EMAIL_EXISTS_ACTIVE

error_code

EMAIL_EXISTS_INACTIVE

error_code

WEAK_PASSWORD

error_code

INVALID_INPUT

error_code

ORG_BANNED

Last updated

Was this helpful?