End User Auth

File Name : enduserauth.js File Path : /server/routes/enduserauth.js End User Auth route contains login and logout routes for End User. Also routes can be added which require authentication. These functionalities are included in Auth Controller.

Login

POST /api/endUserAuth/login

Request Body

Name	Type	Description
phoneNumber	number	Phone Number

200

{
            success: false,
            message: "user not found"
}

or

{
            success: true,
            message: "user found",
            data: {}
}

or

{
            success: false,
            message: "error in logging end user"
}
            
or
            
{
            success: false,
            message: "error in finding end user"
}

Logout

POST /api/endUserAuth/logout

Headers

Name	Type	Description
jwtAccessToken	string	Authorization

Request Body

Name	Type	Description
user	object	User details object

200

{
          success: true,
          message: "User logout successfully"
}

OTP Verify

POST /api/endUserAuth/otpVerify

Path Parameters

Name	Type	Description
	string

Request Body

Name	Type	Description
otp	number	OTP to verify
phoneNumber	number	Phone Number

200

{
              success: false,
              message: "User not found"
}

or

{
              success: true,
              message: "User successfully logged in",
              data: {
                jwtAccessToken: `JWT ${token}`,
                user: updatedUser
              }
}

or

{
              success: false,
              message: "error in otp verification of end user"
}

or

{
              success: false,
              message: "error in finding user"
}

Resend OTP

POST /api/endUserAuth/resendOtp

Request Body

Name	Type	Description
phoneNumber	number	Phone Number

200

{
          success: false,
          message: "User not found"
}

or

{
          success: true,
          message: "Otp send"
}

or

{
          success: false,
          message: "error in resending otp"
}

Check User Existence

POST /api/endUserAuth/checkUserExistance

Request Body

Name	Type	Description
phoneNumber	number	Phone Number

200

{
          success: false,
          message: "User does not exist"
}

or

{
          success: true,
          message: "User exists already"
}

or

{
          success: false,
          message: "error in checking existance of end user"
}