NHnhost
authentication

Sign up with email OTP

Changed on

Register a new user account using email OTP authentication. Sends a one-time password to the specified email address. Use this endpoint to explicitly register a new account. When AUTH_DISABLE_AUTO_SIGNUP is enabled, this is the only way to register through this method.

post/signup/otp/email

Request

  • Base URL
    https://{subdomain}.auth.{region}.nhost.run/v1
  • URL
    https://{subdomain}.auth.{region}.nhost.run/v1/signup/otp/email
  • Auth
    none declared

Request body

emailstring email required

A valid email

Example request

{
  "email": "john.smith@nhost.io",
  "options": {
    "allowedRoles": [
      "me",
      "user"
    ],
    "defaultRole": "user",
    "displayName": "John Smith",
    "locale": "en",
    "metadata": {
      "firstName": "John",
      "lastName": "Smith"
    },
    "redirectTo": "https://my-app.com/catch-redirection"
  }
}

Response

OTP sent to the user's email. To prevent account enumeration, this response is also returned without side effects when the email is already registered.

'OK' required

Changes