Sign up with required email verification

This is most secure way to sign up a user. The registration is not completed until user verifies his/her email address by clicking on a link in the email sent to him/her.

Request

POST /api/auth/register-with-email-verification HTTP/1.1
Content-Type: application/json

{
    "email": Email,
    "password": Password,
    "name": Name,
    "metadata": Metadata
}

Request parameters

Parameter name

Description

Email

Email address of the user. A verification email will be sent to this address.

Password

A user specified password.

Name

Full name.

Metadata

Any arbitrary metadata. Should be a valid JSON object (e.g. {"key": "value"}).

Response

HTTP/1.1 200
Content-Type: application/json

{
    "emailVerificationId": EmailVerificationId
}

Response parameters

Parameter name

Description

EmailVerificationId

The ID of email verification process. This value you probably will not use anywhere, but is available for future functionalities.

Last updated

Was this helpful?