Email Verification

It is optional for user if email is used need to verify by OTP in register, checkout and profile update.

Verify Email API

The Verify Email API is a versatile endpoint used in various stages of the e-commerce application, such as user registration, checkout, and profile updates. This API enables users to verify their email addresses by sending a one-time password (OTP) to the provided email. The email verification process ensures the accuracy and validity of user-provided email addresses, enhancing the security and trustworthiness of user accounts.

Email verification interface

Endpoint

• {{baseurl}}/api/v1/customer/verify-email

Method

• POST

Request Parameters:

• None

Request Body

{
  "email_otp": "otp_example"
}

Response Format:

The API responds with a JSON object containing the verification status and any relevant information.

{
    "status": true,
    "message": "Email verification successfully completed",
    "data": {
        "user": []
    }
}

Authorization: The API requires a valid Bearer token in the request headers to authorize the user.

Features:

• The API initiates the email verification process for the provided email address.

• Users receive a one-time password (OTP) to their email for verification.

• Users must enter the OTP to verify the authenticity of their email address.

Usage

The Verify Email API is utilized when users need to verify their email addresses, typically during the registration process or when updating their account settings.

Resend Email OTP API

The Resend Email OTP API allows users to request a new one-time password (OTP) for email verification. This API is utilized when users need to request a resend of the email OTP, typically when the initial OTP has expired or not been received.

Endpoint

• {{baseurl}}/api/v1/customer/resend-email-otp

Method

• GET

Request Parameters

• None

Request Body

• None

Response Format

The API responds with a JSON object containing the status of the OTP resend request.

    "status": true,
    "message": "OTP sent to your email id",
    "data": {
        "user": []
    }

Authorization

The API requires a valid Bearer token in the request headers to authorize the user.

Features

• The API allows users to request a resend of the email OTP if they did not receive it or if it has expired.

• Users receive a new OTP to their email for verification.

Usage

The Resend Email OTP API is used when users need to request a new OTP for email verification, typically when the initial OTP has expired or not been received.