User Management
Email Verification

Email Verification API

Welcome to the documentation for the Email Verification API. This API helps you get a verification email for user authentication.

Base URL

{baseURL}/v1/users/verify-email | POST

Request Payload

FieldTypeSourceRequiredDescription
codestringbody✅ YesOTP sent to user's email address

Sample Request

curl -X POST {baseURL}/v1/users/verify-email \
  -H 'Content-Type: application/json' \
  -d '{
   "first_name": "Oluwatunmise",
    "last_name": "Adenuga",
    "email": "[email protected]",
    "phone_number": "07031832236",
    "organization_id": "64da45f2605200f551d8e9ac",
    "account_id": "64da4abd605200f551d8e9b6",
    "role_id": "64e8b1de85671e19e26d717d",
    "gender": "male"
  }'

Sample 200 Response

{
  "message": "Users retrieved successfully",
  "data": {
    "items": [
      {
        "_id": "64f3c2fcf3693ad244d7ebcf",
        "first_name": "Oluwatunmise",
        "last_name": "Adenuga",
        "email": "[email protected]",
        "phone_number": "07031832236",
        "role_id": "64e8b1de85671e19e26d717d",
        "is_verified": false,
        "account_id": "64da4abd605200f551d8e9b6",
        "organization_id": "64da45f2605200f551d8e9ac",
        "gender": "male",
        "is_2FA_enabled": false,
        "is_default_password": true,
        "status": "active",
        "security_questions": [],
        "createdAt": "2023-09-02T23:19:24.109Z",
        "updatedAt": "2023-09-02T23:19:26.671Z",
        "__v": 1
      }
    ],
    "meta": {
      "total": 1,
      "page": 1,
      "limit": 5
    }
  },
  "success": true
}
Create UserForgot Password