Skip to main content
POST
/
auth
/
signup
curl --request POST \
  --url https://{deploymentHost}/auth/signup \
  --header 'Content-Type: application/json' \
  --cookie __session= \
  --data '
{
  "first_name": "John",
  "last_name": "Doe",
  "email": "[email protected]",
  "password": "SecurePass123!"
}
'
{
  "status": 200,
  "message": "",
  "data": {
    "signin_attempts": [],
    "signins": [],
    "signup_attempts": [
      {
        "id": "signup_123456789",
        "email": "[email protected]",
        "username": "johndoe",
        "current_step": "verify_email",
        "created_at": "2024-01-01T12:00:00Z"
      }
    ],
    "active_signin": null
  },
  "session": {
    "signin_attempts": [],
    "signins": [],
    "signup_attempts": [
      {
        "id": "signup_123456789",
        "email": "[email protected]",
        "username": "johndoe",
        "current_step": "verify_email",
        "created_at": "2024-01-01T12:00:00Z"
      }
    ],
    "active_signin": null
  },
  "errors": []
}

Authorizations

​
__session
string
cookie
required

Session cookie authentication for production deployments. The session token is automatically set as an HTTP-only, secure cookie.

Body

application/json
​
password
string
required

User's password (6-125 characters, must contain number and symbol)

Required string length: 6 - 125
​
first_name
string

User's first name

​
last_name
string

User's last name

​
username
string

Unique username

​
email
string<email>

Email address

​
phone_number
string

Phone number with country code

Response

Sign-up attempt created successfully

​
status
integer
required

HTTP status code

​
message
string
required

Response message (empty for success)

​
data
any
required

Response data (can be any type)

​
session
object
required
​
errors
object[]
required

Array of error objects (empty for success)