Sign Up

This guide explains how to implement user registration in the Calwe application.

Request Verification Code

Endpoint

• Method: POST
• URL: /v1/customer/register

Request Headers

Header	Value	Required
Content-Type	application/json	Yes
Accept	application/json	Yes

Request Body

Parameter	Type	Description	Required
first_name	string	User's first name	Yes
last_name	string	User's last name	Yes
email	string	User's email address	Yes
email_confirmation	string	User's email address confirmation	Yes
password	string	User's password	Yes
password_confirmation	string	User's password confirmation	Yes
phone	string	User's phone	Yes
gender	string	User's gender	Yes
birth_date	string	User's birth date	Yes
national_id	string	User's national	Yes
accept_terms	string	User's accept terms	Yes

Success Response

{
    "success": true,
    "message": "تم التسجيل بنجاح.",
    "data": {
        "id": "uuid",
        "firstName": "Ahmed",
        "lastName": "Mohammed",
        "email": "customer@gmail.com",
        "birthDate": "1993/12/31",
        "phone": "500666755",
        "gender": "ذكر",
        "avatar": "https://i.ibb.co/g4BR50S/avatar.png",
        "acceptTerms": true
    },
    "statusCode": 200
}

Error Responses

Email And Phone Are Already Exists (422)

{
    "success": false,
    "message": "حدث خطأ في البيانات المرسلة يرجى التحقق منها.",
    "errors": {
        "email": "قيمة البريد الإلكتروني مُستخدمه من قبل.",
        "phone": "قيمة رقم الهاتف مُستخدمه من قبل."
    },
    "data": [],
    "statusCode": 422
}

Invalid Email Format (422)

{
    "success": false,
    "message": "حدث خطأ في البيانات المرسلة يرجى التحقق منها.",
    "errors": {
        "email": "صيغة البريد الإلكتروني غير صحيحة."
    },
    "data": [],
    "statusCode": 422
}

Activate Email Account

Endpoint

• Method: POST
• URL: /v1/customer/activate-account

Request Headers

Header	Value	Required
Content-Type	application/json	Yes
Accept	application/json	Yes

Request Body

Parameter	Type	Description	Required
email	string	Email address used in signup request	Yes
token	string	Verification code received via email	Yes

Success Response

{
    "success": true,
    "message": "تم تفعيل بريدك الإلكتروني بنجاح.",
    "data": {
        "email": "exaple@gmail.com"
    },
    "statusCode": 200
}

Error Responses

Invalid Code (422)

{
    "success": false,
    "message": "رمز التنشيط هذا غير صالح.",
    "errors": {
        "token": "رمز التنشيط هذا غير صالح."
    },
    "data": [],
    "statusCode": 422
}

Phone Verification

Endpoint

• Method: POST
• URL: /v1/customer/phone-verification

Request Headers

Header	Value	Required
Content-Type	application/json	Yes
Accept	application/json	Yes

Request Body

Parameter	Type	Description	Required
phone_verified_code	string	Verification code received via phone	Yes

Success Response

{
    "success": true,
    "message": "تم التحقق من الكود بنجاح",
    "data": {
        "phone": "500886779"
    },
    "statusCode": 200
}

Error Responses

Invalid Code (422)

{
    "success": false,
    "message": "كود التفعيل غير صحيح",
    "data": [],
    "statusCode": 301
}

Change Phone Number

Endpoint

• Method: POST
• URL: /v1/customer/change-phone-number

Request Headers

Header	Value	Required
Content-Type	application/json	Yes
Accept	application/json	Yes
Authorization	Bearer token	Yes

Request Body

Parameter	Type	Description	Required	Validation Rules
phone	string	New phone number	Yes	required, phone:SA,unique:mentors,phone

Success Response

{
    "success": true,
    "message": "تم تغيير رقم الهاتف بنجاح",
    "data": [],
    "statusCode": 200
}

Error Responses

Validation Error (422)

{
    "success": false,
    "message": "بيانات غير صحيحة",
    "data": {
        "phone": [
            "رقم الهاتف غير صحيح",
            "رقم الهاتف مسجل مسبقاً"
        ]
    },
    "statusCode": 422
}

Example Implementation Flow

1. User fill its data information
2. Application Sends Activate Email And Phone Verification
3. User receives verification code via email