Skip to main content
POST
/
api
/
canary
/
authentication
/
sign-up
/
email
Sign up with email
curl --request POST \
  --url http://localhost:3000/api/canary/authentication/sign-up/email \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "John Doe",
  "email": "[email protected]",
  "password": "StrongPassword123!",
  "image": "https://example.com/avatar.jpg",
  "callbackURL": "https://example.com/auth/callback",
  "rememberMe": true
}
'
{
  "statusCode": 400,
  "message": [
    "Invalid input data"
  ],
  "error": "Bad Request"
}

Body

application/json
​
name
string
required

The name of the user

Example:

"John Doe"

​
email
string
required

The email address of the user

Example:

"[email protected]"

​
password
string
required

The password for the user account

Example:

"StrongPassword123!"

​
image
string

Optional URL to the user's profile image

Example:

"https://example.com/avatar.jpg"

​
callbackURL
string

Optional callback URL after successful sign-up

Example:

"https://example.com/auth/callback"

​
rememberMe
boolean

Optional flag to indicate if the user should be remembered

Example:

true

Response

User created successfully