Skip to main content
POST
/
signup
/
email-password
Sign up with email and password
curl --request POST \
  --url https://{subdomain}.auth.{region}.nhost.run/v1/signup/email-password \
  --header 'Content-Type: application/json' \
  --data '
{
  "email": "[email protected]",
  "password": "Str0ngPassw#ord-94|%",
  "options": {
    "allowedRoles": [
      "me",
      "user"
    ],
    "defaultRole": "user",
    "displayName": "John Smith",
    "locale": "en",
    "metadata": {
      "firstName": "John",
      "lastName": "Smith"
    },
    "redirectTo": "https://my-app.com/catch-redirection"
  }
}
'
{
  "session": {
    "accessToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
    "accessTokenExpiresIn": 900,
    "refreshTokenId": "2c35b6f3-c4b9-48e3-978a-d4d0f1d42e24",
    "refreshToken": "2c35b6f3-c4b9-48e3-978a-d4d0f1d42e24",
    "user": {
      "avatarUrl": "https://myapp.com/avatars/user123.jpg",
      "createdAt": "2023-01-15T12:34:56Z",
      "defaultRole": "user",
      "displayName": "John Smith",
      "emailVerified": true,
      "id": "2c35b6f3-c4b9-48e3-978a-d4d0f1d42e24",
      "isAnonymous": false,
      "locale": "en",
      "metadata": {
        "firstName": "John",
        "lastName": "Smith"
      },
      "phoneNumberVerified": false,
      "roles": [
        "user",
        "customer"
      ],
      "email": "[email protected]",
      "phoneNumber": "+12025550123",
      "activeMfaType": "<string>"
    }
  }
}

Body

application/json

User registration information including email, password, and optional profile data

Request to register a new user with email and password

​
email
string<email>
required

Email address for the new user account

Example:

"[email protected]"

​
password
string
required

Password for the new user account

Required string length: 3 - 50
Example:

"Str0ngPassw#ord-94|%"

​
options
object

Response

Registration successful. If email verification is required, session will be null.

Container for session information

​
session
object

User authentication session containing tokens and user information