# Users ## User Profile Status ```shell curl --location 'http://192.168.1.180:8084/mi97/api.vedpad.in/user/profile_status' \ --header 'Referer: http://rmd.vedaay.mulika.in' \ --header 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJcnGvFyr9PNbstCN8o9L2U8fJILM' ``` > Responce: ```json '{ "status": "success", "code": 200, "message": "Profile status verification generated.", "data": { "user_id": 511, "role_name": "Student", "total_fields_defined": 13, "filled_fields_count": 13, "missing_fields_count": 0, "completion_percentage": 100, "is_profile_completed": true, "missing_fields": [] } }' ``` GET /users/profile_status ## User Brandings ```shell curl --location 'http://192.168.1.180:8084/mi97/api.vedpad.in/user/branding' \ --header 'Referer: http://rmd.vedaay.mulika.in' \ --header 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJcnGvFyr9PNbstCN8o9L2U8fJILM' ``` > Responce: ```json '{ "status": "success", "message": "User found.", "code": 200, "data": { "details": { "domain": "192.168.1.180:8084", "brand_name": "EduSphere Pro", "brand_tagline": "Empowering Educationnn", "brand_about_us": "A leading provider of educational management solutions.", "brand_logo_url": { "media_id": "70", "media_src": "https://vedaay-api.mulika.in/media/src/70/1772189405_logo_03.png", "media_alt": "logo", "media_title": "logoimg", "media_description": "logodesc" }, "brand_favicon_url": { "media_id": "69", "media_src": "https://vedaay-api.mulika.in/media/src/69/1772189212_Routes.php%281%29.zip", "media_alt": "routes", "media_title": "routesimg", "media_description": "routesdesc" }, "brand_banner_image_url": { "media_id": "68", "media_src": "https://vedaay-api.mulika.in/media/src/68/1772189071_ex_marketing_catlog.sql.zip", "media_alt": "market", "media_title": "marketimg", "media_description": "marketdesc" }, "brand_login_background_image": { "media_id": "67", "media_src": "https://vedaay-api.mulika.in/media/src/67/1772189047_product.txt.zip", "media_alt": "product", "media_title": "productimg", "media_description": "productdesc" }, "brand_primary_color": "#4A90E2", "brand_secondary_color": "#AAAA23", "brand_text_color": "#333333", "brand_button_color": "#007AAA", "brand_font_family": "Inter", "org_name": "Global Education Trust", "org_code": "GET-2026", "org_type": "Academic Institution", "org_registration_no": "REG123456789", "org_gst_no": "27AAAAA0000A1Z5", "org_pan_no": "ABCDE1234F", "org_established_year": "2010", "org_address_line1": "123 Innovation Drive", "org_address_line2": "Cyber City", "org_city": "Pune", "org_district": "shirur", "org_state": "Maharashtra", "org_country": "India", "org_pincode": "411045", "verified": "true" } } }' ``` GET /user/branding ## Apply Scope ```shell curl -X POST https://vedaay-api.mulika.in/users/apply_scope --header 'Content-Type: application/json' \ --header 'Authorization: Bearer eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJpYXQiOjE3NzU1NjUzOTksImV4cCI6MTc3NTY1MTc5OSwidXNlcl9pZCI6IjM2NiIsInVzZXJuYW1lIjoibmlsYW0yNF8xMjA0IiwiZW1haWwiOiJuaWxhbTEyQGdtYWlsLmNvbSJ9.j9OVP1wIVRXq-xH6WLSWfjGSCGaBZLeU_8ZYcw-54Xo' \ ``` > Responce: ```json 'done scope applied' ``` POST /users/apply_scope ## User Properties The Users API allows you to create, view, update, and delete individual, or a batch, of Users. Attributes | Type | Is Required | Description --------- | ------- | ----------- | ----------- user_id | integer | required |ID of user user_name | string | required |Name of the User first_name | string | required |First name of the User middle_name| string | required |Middle name of the User last_name | string | required |Last name of the User email | string | required |Email of the User mobile | integer | required |Mobile Number of user role_id | integer | required |role id of the role parent_id | integer | required |parent id of the parent user profile_img| integer | required |media_id of the image created_by | integer | required |user_id of the user who has created a this user status | enum | required |active or inactive scope | integer | required |scope store its parent id's in a slash format created_at | integer | required |user created time updated_at | integer | required |user updated time details | json | required |Extra details and fields for the users admin , parent , student ,District Franchise , School Franchise , Unit Franchise , Teacher ## List All Users ```shell curl -X GET https://vedaay-api.mulika.in/users -H "Content-Type: application/json" \ -H 'Authorization: Bearer eyJ0eXAiOiJKNiJ9.B7Y3J9FWtgjby4P8-LX_Vkeob6CE ``` > Responce: ```json '{ "status": "success", "message": "1 users retrieved successfully", "code": 200, "pagination": { "current_page": 1, "per_page": 1, "total_records": 150, "total_pages": 150 }, "data": [ { "user_id": "107", "user_name": "rohan", "first_name": "rohan", "middle_name": "rama", "last_name": "sarode", "email": "rohan@gmail.com", "mobile": "9876543210", "password": "$2y$12$/77QhWspA/U2.xf.GN81KuQc6av78DDMGnzIlcQZAlNER/ViOlG6i", "role_id": "2", "parent_id": "330", "profile_img": { "media_id": "54", "media_src": "https://vedaay-api.mulika.in/media/src/54/1769835779_10file.png", "media_alt": "10file image", "media_title": "10file image two", "media_description": "10file image three" }, "status": "active", "created_by": "142", "scope": "/330", "created_at": "2026-01-29 17:03:11", "updated_at": "2026-03-06 14:42:50", "details": { "admin_domain": "192.168.1.180:8084", "admin_brand_name": "EduSphere Pro", "admin_brand_tagline": "Empowering Educationnn", "admin_brand_about_us": "A leading provider of educational management solutions.", "admin_brand_logo_url": "70", "admin_brand_favicon_url": "69", "admin_brand_banner_image_url": "68", "admin_brand_login_background_image": "67", "admin_brand_primary_color": "#4A90E2", "admin_brand_secondary_color": "#AAAA23", "admin_brand_text_color": "#333333", "admin_brand_button_color": "#007AAA", "admin_brand_font_family": "Inter", "admin_org_name": "Global Education Trust", "admin_org_code": "GET-2026", "admin_org_type": "Academic Institution", "admin_org_registration_no": "REG123456789", "admin_org_gst_no": "27AAAAA0000A1Z5", "admin_org_pan_no": "ABCDE1234F", "admin_org_established_year": "2010", "admin_org_address_line1": "123 Innovation Drive", "admin_org_address_line2": "Cyber City", "admin_org_city": "Pune", "admin_org_district": "shirur", "admin_org_state": "Maharashtra", "admin_org_country": "India", "admin_org_pincode": "411045", "verified": "true", "email_otp": "542064", "otp_expires_at": "2026-03-06 09:09:57" }, "reg_number": "STD-294-2026-00035" } ] }' ``` GET /users 1. GET /users 2. GET /users/{id} 3. GET /users?page=1&per_page=20 4. GET /users?search=mulika 5. GET /users?include=107,135,142&exclude=145 6. GET /users?column_count=status&value=active 7. GET /users?orderby=created_at&order=ASC 8. GET /users?column_count=status,first_name,role_id 9. GET /users?filters[role_id]=1&filters[parent_id]=0 10. GET /users?filters[status]=inactive 11. GET /users?filters[role_id]=1,2,3 12. GET /users?fields=user_id,user_name,email,role_id 13. GET /users?fields=user_id,email,meta:student_school_name ### Available Parameters Parameters | Type | Description ----------------| ------- | ----------- page | integer | Current page of the collection. Default is 1. per_page | integer | Maximum number of items to be returned in result set. Default is 10. search | string | Limit results to those matching a string. exclude | array | Ensure result set excludes specific IDs. include | array | Limit result set to specific ids. order | string | Order sort attribute ascending or descending. Options: asc and desc. Default is desc. orderby | string | Sort collection by object attribute. Options: date, modified, id, title . column_count | string | get count of the data values for the field filters(role_id)| integer | get the users bu the role single and multiple ex- filters[role_id]=1,2,3 fields | string | column filter applied to get columns details seperated by comma , also get the fields for single using use "meta:" ## Get Single User ```shell curl -X GET https://vedaay-api.mulika.in/users/107 -H "Content-Type: application/json" \ -H 'Authorization: Bearer eyJ0eXAiOiJKNiJ9.B7Y3J9FWtgjby4P8-LX_Vkeob6CE ``` > Responce: ```json '{ "status": "success", "message": "User found.", "code": 200, "data": { "user_id": "107", "user_name": "rohan", "first_name": "rohan", "middle_name": "rama", "last_name": "sarode", "email": "rohan@gmail.com", "mobile": "9876543210", "role_id": "2", "parent_id": "330", "profile_img": { "media_id": "54", "media_src": "https://vedaay-api.mulika.in/media/src/54/1769835779_10file.png", "media_alt": "10file image", "media_title": "10file image two", "media_description": "10file image three" }, "status": "active", "created_by": "142", "scope": "/330", "created_at": "2026-01-29 17:03:11", "updated_at": "2026-03-06 14:42:50", "details": { "admin_domain": "192.168.1.180:8084", "admin_brand_name": "EduSphere Pro", "admin_brand_tagline": "Empowering Educationnn", "admin_brand_about_us": "A leading provider of educational management solutions.", "admin_brand_logo_url": "70", "admin_brand_favicon_url": "69", "admin_brand_banner_image_url": "68", "admin_brand_login_background_image": "67", "admin_brand_primary_color": "#4A90E2", "admin_brand_secondary_color": "#AAAA23", "admin_brand_text_color": "#333333", "admin_brand_button_color": "#007AAA", "admin_brand_font_family": "Inter", "admin_org_name": "Global Education Trust", "admin_org_code": "GET-2026", "admin_org_type": "Academic Institution", "admin_org_registration_no": "REG123456789", "admin_org_gst_no": "27AAAAA0000A1Z5", "admin_org_pan_no": "ABCDE1234F", "admin_org_established_year": "2010", "admin_org_address_line1": "123 Innovation Drive", "admin_org_address_line2": "Cyber City", "admin_org_city": "Pune", "admin_org_district": "shirur", "admin_org_state": "Maharashtra", "admin_org_country": "India", "admin_org_pincode": "411045", "verified": "true", "email_otp": "542064", "otp_expires_at": "2026-03-06 09:09:57" }, "reg_number": "STD-294-2026-00035" } }' ``` GET /users/{id} ### Parameters | Parameter | Type | Description | | --------- | ------- | ----------------- | | user_id | integer | ID of the user | ## Create ```shell curl -X POST https://vedaay-api.mulika.in/users -H "Content-Type: application/json" \ -H Authorization: Bearer eyJ0eXAiOiJKNiJ9.B7Y3J9FWtgjby4P8-LX_Vkeob6CE -d '{ "user_name": "tejinfo", "first_name": "vishtejinfoal", "middle_name": "tejinfo", "last_name": "tejinfo", "email": "tejinfo@gmail.com", "mobile": "9876543210", "password": "11111111", "role_id": 4, "parent_id": 302, "profile_img": 70, "details": { "student_address_line1": "Flat 202, Sunshine Apartments", "student_address_line2": "Near Central Park", "student_city": "Mumbai", "student_state": "Maharashtra", "student_country": "India", "student_pincode": "400001", "student_parent_id": "PAR-9901", "student_parent_relation": "Father", "student_dob": "2012-05-15", "student_gender": "Male", "student_school_name": "St. Xavier's High School", "student_grade_class": "Class 8", "student_enrollment_date": "2026-01-10" } }' ``` > Responce: ```json '{ "status": "success", "message": "User found.", "code": 200, "data": { "user_id": "559", "user_name": "tejinfo", "first_name": "vishtejinfoal", "middle_name": "tejinfo", "last_name": "tejinfo", "email": "tejinfo@gmail.com", "mobile": "9876543210", "role_id": "4", "parent_id": "302", "profile_img": { "media_id": "70", "media_src": "https://vedaay-api.mulika.in/media/src/70/1772189405_logo_03.png", "media_alt": "pinga", "media_title": "hokua", "media_description": "apksd" }, "status": "active", "created_by": "302", "scope": "/330/294/302", "created_at": "2026-04-13 11:19:05", "updated_at": "2026-04-13 11:19:05", "details": { "student_address_line1": "Flat 202, Sunshine Apartments", "student_address_line2": "Near Central Park", "student_city": "Mumbai", "student_state": "Maharashtra", "student_country": "India", "student_pincode": "400001", "student_parent_id": "PAR-9901", "student_parent_relation": "Father", "student_dob": "2012-05-15", "student_gender": "Male", "student_school_name": "St. Xavier's High School", "student_grade_class": "Class 8", "student_enrollment_date": "2026-01-10", "student_reg_number": "STD-302-2026-00024" }, "reg_number": "STD-294-2026-00035" } }' ``` POST /users ## Update User ```shell curl -X PUT https://vedaay-api.mulika.in/users/379 -H "Content-Type: application/json" \ -H Authorization: Bearer eyJ0eXAiOiJKNiJ9.B7Y3J9FWtgjby4P8-LX_Vkeob6CE -d '{ "user_name": "roger", "first_name": "almas", "middle_name": "chris", "last_name": "steelar", "email": "broke@gmail.com", "mobile": "9876543210", "password": "11111111", "role_id": 3, "parent_id": 151, "profile_img": 56, "status": "inactive", "details": { "student_address_line1": "Flat 202, Sunshine Apartments", "student_address_line2": "Near Central Park", "student_city": "Mumbai", "student_state": "Maharashtra", "student_country": "India", "student_pincode": "400001", "student_parent_id": "PAR-9901", "student_parent_relation": "Father", "student_dob": "2012-05-15", "student_gender": "Male", "student_admission_no": "ADM-2026-0045", "student_school_name": "St. Xaviers High School", "student_grade_class": "8th Grade", "student_enrollment_date": "2026-01-10" } }' ``` > Responce: ```json '{ "status": "success", "message": "User updated successfully.", "code": 200, "data": { "user_id": "379", "user_name": "pixell", "first_name": "sanja", "middle_name": "spiro", "last_name": "goldy", "email": "pixel@gmail.com", "mobile": "9876543210", "role_id": "4", "parent_id": "153", "profile_img": "56", "status": "active", "created_by": "377", "scope": "/330/107/377", "created_at": "2026-02-19 13:15:51", "updated_at": "2026-03-17 12:47:33", "details": { "student_address_line1": "Flat 202, yang Apartmentsl", "student_address_line2": "Near Central Park", "student_city": "Mumbai", "student_state": "Maharashtra", "student_country": "India", "student_pincode": "400001", "student_parent_id": "PAR-9901", "student_parent_relation": "Father", "student_dob": "2012-05-15", "student_gender": "Male", "student_school_name": "St. Xavier's High School", "student_grade_class": "Class 6", "student_enrollment_date": "2026-01-10", "student_reg_number": "STD-377-153-00002" }, "role_name": "Student" } }' ``` PUT /users/{id} ### Available Parameters | Parameters| Type | Description | | --------- | ------- | ------------------------- | | user_id | integer | ID of user | ## Delete user DELETE /users/id ```shell curl -X DELETE https://vedaay-api.mulika.in/users/31 -H "Content-Type: application/json" \ -H Authorization: Bearer eyJ0eXAiOiJKNiJ9.B7Y3J9FWtgjby4P8-LX_Vkeob6CE ``` > Responce: ```json '{ "status": "success", "message": "User and all associated data deleted successfully.", "code": 200, "data": { "user_id": "484", "user_name": "unitfr3", "email": "unitfr3@gmail.com", "mobile": "9876543210" } }' ``` DELETE /user/id ## Get User Profile ```shell curl -X GET https://vedaay-api.mulika.in/users/profile -H "Content-Type: application/json" \ -H Authorization: Bearer eyJ0eXAiOiJKNiJ9.B7Y3J9FWtgjby4P8-LX_Vkeob6CE ``` > Responce: ```json '{ "status": "success", "message": "User found.", "code": 200, "data": { "user_id": "330", "user_name": "SUP-00005", "first_name": "mulika", "middle_name": "platinum", "last_name": "company", "email": "superadmins@gmail.com", "mobile": "9876543210", "role_id": "1", "parent_id": "0", "profile_img": { "media_id": "57", "media_src": "https://vedaay-api.mulika.in/media/src/57/1770458526_bottles1.jpeg", "media_alt": "main_file", "media_title": "main_file_form", "media_description": "file_format" }, "status": "active", "created_by": "107", "scope": "/", "created_at": "2026-02-13 11:19:55", "updated_at": "2026-04-13 12:07:21", "details": { "super_admin_domain": "platinum.com", "super_admin_brand_name": "EduSphere Pro", "super_admin_brand_tagline": "Empowering Education", "super_admin_brand_about_us": "A leading provider of educational management solutions.", "super_admin_brand_logo_url": "69", "super_admin_brand_favicon_url":"68", "super_admin_brand_banner_image_url": "67", "super_admin_brand_login_background_image":"66", "super_admin_brand_primary_color": "#4A90E2", "super_admin_brand_secondary_color": "#F5A623", "super_admin_brand_text_color": "#333333", "super_admin_brand_button_color": "#007AFF", "super_admin_brand_font_family": "Inter", "super_admin_org_name": "Global Education Trust", "super_admin_org_code": "GET-2026", "super_admin_org_type": "Academic Institution", "super_admin_org_registration_no": "REG123456789", "super_admin_org_gst_no": "27AAAAA 5", "super_admin_org_pan_no": "ABCDE1234F", "super_admin_org_established_year": "2010", "super_admin_org_address_line1": "123 Innovation Drive", "super_admin_org_address_line2": "Cyber City", "super_admin_org_city": "Pune", "super_admin_org_district": "Pune", "super_admin_org_state": "Maharashtra", "super_admin_org_country": "India", "super_admin_org_pincode": "411045", "super_admin_reg_number": "SUP-00005" }, "reg_number": "SUP-00005" } }' ``` GET users/profile ## Update Profile ```shell curl -X PUT https://vedaay-api.mulika.in/users/update_profile -H "Content-Type: application/json" \ -H Authorization: Bearer eyJ0eXAiOiJKNiJ9.B7Y3J9FWtgjby4P8-LX_Vkeob6CE -d '{ "user_name": "greendistrictt", "first_name": "backlspav", "middle_name": "enter", "last_name": "brown", "email": "greendistrict@gmail.com", "mobile": "9876543210", "password": "11111111", "role_id": 5, "parent_id": 476, "profile_img": 55, "details": { "franchise_address_line1": "Shop No. 12, Crystal sarvam", "franchise_address_line2": "Opposite Railway Station", "franchise_city": "Pune", "franchise_district": "Pune", "franchise_state": "Maharashtra", "franchise_country": "India", "franchise_pincode": "411011", "franchise_domain": "edu-pune.com", "franchise_brand_name": "greendistrict Franchise", "franchise_brand_tagline": "Quality Learning in Every Corner", "franchise_brand_about_us": "Providing educational support across the Pune district.", "franchise_brand_logo_url": "66", "franchise_brand_favicon_url": "67", "franchise_brand_banner_image_url": "68", "franchise_brand_login_background_image": "69", "franchise_brand_primary_color": "#1A5276", "franchise_brand_secondary_color": "#D4AC0D", "franchise_brand_text_color": "#212121", "franchise_brand_button_color": "#2E86C1", "franchise_brand_font_family": "Roboto", "franchise_brand_form_id": "58", "franchise_name": "Bright Minds Unit 01", "franchise_area": "Viman Nagar", "franchise_gst_number": "27AAACU1234A1Z1", "franchise_agreement_start": "2026-05-01", "franchise_agreement_end": "2029-04-30" } }' ``` > Responce: ```json '{ "status": "success", "message": "Profile updated successfully.", "code": 200, "data": { "user_id": "497", "user_name": "greendistrict", "first_name": "backlspav", "middle_name": "enter", "last_name": "brown", "email": "greendistrict@gmail.com", "mobile": "9876543210", "role_id": "5", "parent_id": "476", "profile_img": "55", "status": "active", "created_by": "496", "scope": "/330/496", "created_at": "2026-03-05 10:49:01", "updated_at": "2026-03-05 18:45:14", "details": { "franchise_address_line1": "Shop No. 12, Crystal sarvam", "franchise_address_line2": "Opposite Railway Station", "franchise_city": "Pune", "franchise_district": "Pune", "franchise_state": "Maharashtra", "franchise_country": "India", "franchise_pincode": "411011", "franchise_domain": "edu-pune.com", "franchise_brand_name": "greendistrict Franchise", "franchise_brand_tagline": "Quality Learning in Every Corner", "franchise_brand_about_us": "Providing educational support across the Pune district.", "franchise_brand_logo_url": "66", "franchise_brand_favicon_url": "67", "franchise_brand_banner_image_url": "68", "franchise_brand_login_background_image": "69", "franchise_brand_primary_color": "#1A5276", "franchise_brand_secondary_color": "#D4AC0D", "franchise_brand_text_color": "#212121", "franchise_brand_button_color": "#2E86C1", "franchise_brand_font_family": "Roboto", "franchise_brand_form_id": "58", "franchise_name": "Bright Minds Unit 01", "franchise_area": "Viman Nagar", "franchise_gst_number": "27AAACU1234A1Z1", "franchise_agreement_start": "2026-05-01", "franchise_agreement_end": "2029-04-30", "district_franchise_reg_number": "DFC-MH-PN-476-00018" }, "role_name": "District franchise" } }' ``` PUT /users/update_profile ## User-Roles users roles api defines the user type ```shell curl -X GET https://vedaay-api.mulika.in/users/roles -H "Content-Type: application/json" \ -H Authorization: Bearer eyJ0eXAiOiJKNiJ9.B7Y3J9FWtgjby4P8-LX_Vkeob6CE ``` > Responce: ```json '{ "status": "success", "message": "Roles retrieved successfully", "code": 200, "pagination": { "current_page": 1, "per_page": 10, "total_records": 7, "total_pages": 1 }, "data": [ { "role_id": "1", "role_name": "Super Admin", "role_slug": "super_admin" "role_fields": "role_fields", "role_parent": [], "role_child": ["admin"] }, { "role_id": "2", "role_name": "Admin", "role_slug": "admin" "role_fields": "role_fields", "role_parent": "super_admin", "role_child": ["parent","student","district_franchise","school_franchise","unit_franchise","teacher"] }, { "role_id": "3", "role_name": "Parent", "role_slug": "parent" "role_fields": "role_fields", "role_parent": ["district_franchise","school_franchise","unit_franchise"], "role_child": [] }, { "role_id": "4", "role_name": "Student", "role_slug": "student" "role_fields": "role_fields", "role_parent": ["district_franchise", "school_franchise", "unit_franchise"], "role_child": [] }, { "role_id": "5", "role_name": "District franchise", "role_slug": "district_franchise" "role_fields": "role_fields", "role_parent": ["admin"], "role_child": ["parent", "student", "school_franchise", "unit_franchise", "teacher"] }, { "role_id": "6", "role_name": "School franchise", "role_slug": "school_franchise" "role_fields": "role_fields", "role_parent": ["district_franchise"], "role_child": ["parent", "student", "teacher"] }, { "role_id": "7", "role_name": "Unit franchise", "role_slug": "unit_franchise" "role_fields": "role_fields", "role_parent": ["district_franchise"], "role_child": ["parent", "student", "teacher"] }, { "role_id": "8", "role_name": "Teacher", "role_slug": "teacher" "role_fields": "role_fields", "role_parent": ["district_franchise", "school_franchise", "unit_franchise"], "role_child": [] } ] } ``` GET /users/roles ### Role table Attribute | Type | Description ----------- | ------- | ----------- role_id | integer | ID of a role role_name | string | Name of the role role_slug | string | Slug of the course role_fields | json | fields of the role role_parent | json | parent of role role_child | json | child of role ### Available Roles 1. Admin 2. Parent 3. Student 4. District Franchise 5. School Fracchise 6. Unit Franchise 7. Teacher 8. Super Admin ## Super Admin POST /users ```shell curl -X POST https://vedaay-api.mulika.in/users -H "Content-Type: application/json" \ -H Authorization: Bearer eyJ0eXAiOiJKNiJ9.B7Y3J9FWtgjby4P8-LX_Vkeob6CE -d '{ "user_name": "superadmin", "first_name": "supraa", "middle_name": "supraa", "last_name": "Sharma", "email": "hellosuperadmin@example.com", "mobile": "9876543210", "password": "11111111", "role_id": 8, "parent_id": 0, "profile_img": 98, "details": { "super_admin_domain": "example.com", "super_admin_brand_name": "EduSphere Pro", "super_admin_brand_tagline": "Empowering Education", "super_admin_brand_about_us": "A leading provider of educational management solutions.", "super_admin_brand_logo_url": "66", "super_admin_brand_favicon_url": "67", "super_admin_brand_banner_image_url": "68", "super_admin_brand_login_background_image": "69", "super_admin_brand_primary_color": "#4A90E2", "super_admin_brand_secondary_color": "#F5A623", "super_admin_brand_text_color": "#333333", "super_admin_brand_button_color": "#007AFF", "super_admin_brand_font_family": "Inter", "super_admin_org_name": "Global Education Trust", "super_admin_org_code": "GET-2026", "super_admin_org_type": "Academic Institution", "super_admin_org_registration_no": "REG123456789", "super_admin_org_gst_no": "27AAAAA0000A1Z5", "super_admin_org_pan_no": "ABCDE1234F", "super_admin_org_established_year": 2010, "super_admin_org_address_line1": "123 Innovation Drive", "super_admin_org_address_line2": "Cyber City", "super_admin_org_city": "Pune", "super_admin_org_district": "Pune", "super_admin_org_state": "Maharashtra", "super_admin_org_country": "India", "super_admin_org_pincode": "411045" } } ``` > Responce: ```json { "status": "success", "message": "User created successfully.", "code": 200, "reg_number": "SUP-00007", "data": { "user_id": "315", "user_name": "SUP-00007", "first_name": "supraa", "middle_name": "supraa", "last_name": "Sharma", "email": "hellosuperadmin@example.com", "mobile": "9876543210", "role_id": "2", "parent_id": "0", "profile_img": { "media_id": "57", "media_src": "https://vedaay-api.mulika.in/media/src/57/1770458526_bottles1.jpeg", "media_alt": "main_file", "media_title": "main_file_form", "media_description": "file_format" }, "status": "active", "created_by": "107", "scope": "/", "created_at": "2026-02-04 10:56:53", "updated_at": "2026-02-04 10:56:53", "role_name": "Super Admin", "details": { "super_admin_domain": "example.com", "super_admin_brand_name": "EduSphere Pro", "super_admin_brand_tagline": "Empowering Education", "super_admin_brand_about_us": "A leading provider of educational management solutions.", "super_admin_brand_logo_url": "66", "super_admin_brand_favicon_url": "67", "super_admin_brand_banner_image_url": "68", "super_admin_brand_login_background_image": "69", "super_admin_brand_primary_color": "#4A90E2", "super_admin_brand_secondary_color": "#F5A623", "super_admin_brand_text_color": "#333333", "super_admin_brand_button_color": "#007AFF", "super_admin_brand_font_family": "Inter", "super_admin_org_name": "Global Education Trust", "super_admin_org_code": "GET-2026", "super_admin_org_type": "Academic Institution", "super_admin_org_registration_no": "REG123456789", "super_admin_org_gst_no": "27AAAAA0000A1Z5", "super_admin_org_pan_no": "ABCDE1234F", "super_admin_org_established_year": 2010, "super_admin_org_address_line1": "123 Innovation Drive", "super_admin_org_address_line2": "Cyber City", "super_admin_org_city": "Pune", "super_admin_org_district": "Pune", "super_admin_org_state": "Maharashtra", "super_admin_org_country": "India", "super_admin_org_pincode": "411045", "super_admin_reg_number": "SUP-00007" }, } }' ``` ### Super Admin Properties | Attributes | Type | Description |-----------------------------------|---------------|-------------------------------------- | super_admin_domain | string | Admin domain name (e.g., example.com) | super_admin_brand_name | string | Admin brand name (e.g., EduSphre Pro) | super_admin_brand_tagline | string | Admin brand tagline | super_admin_brand_about_us | string | About us description for the brand | super_admin_brand_logo_url | string | media_id for brand logo | super_admin_brand_favicon_url | string | media_id for brand favicon | super_admin_brand_banner_image_url| string | media_id for brand banner image | super_admin_brand_login_background_image | string | media_id for login background image | super_admin_brand_primary_color | string | Primary brand color (hex) | super_admin_brand_secondary_color | string | Secondary brand color (hex) | super_admin_brand_text_color | string | Text color (hex) | super_admin_brand_button_color | string | Button color (hex) | super_admin_brand_font_family | string | Font family for branding | super_admin_org_name | string | Organization name | super_admin_org_code | string | Organization code (e.g., GET-2026) | super_admin_org_type | string | Type of organization | super_admin_org_registration_no | string | Registration number | super_admin_org_gst_no | string | GST number | super_admin_org_pan_no | string | PAN number | super_admin_org_established_year | integer | Year organization was established | super_admin_org_address_line1 | string | Address line 1 | super_admin_org_address_line2 | string | Address line 2 | super_admin_org_city | string | City | super_admin_org_district | string | District | super_admin_org_state | string | State | super_admin_org_country | string | Country | super_admin_org_pincode | string | PIN code | super_admin_reg_number | string | super_admin_reg_number ## Admin POST /users ```shell curl -X POST https://vedaay-api.mulika.in/users -H "Content-Type: application/json" \ -H Authorization: Bearer eyJ0eXAiOiJKNiJ9.B7Y3J9FWtgjby4P8-LX_Vkeob6CE -d '{ "user_name": "balajjiadmin", "first_name": "admin", "middle_name": "supraa", "last_name": "Sharma", "email": "balajjiadmin@gmail.com", "mobile": "9876543210", "password": "11111111", "role_id": 2, "parent_id":330, "profile_img": "73", "details": { "admin_domain": "balajjiadmin-org", "admin_brand_name": "blueadmin Pro", "admin_brand_tagline": "Empowering Education", "admin_brand_about_us": "A leading provider of educational management solutions.", "admin_brand_logo_url": "70", "admin_brand_favicon_url": "71", "admin_brand_banner_image_url": "66", "admin_brand_login_background_image": "69", "admin_brand_primary_color": "#4A90E2", "admin_brand_secondary_color": "#AAAA23", "admin_brand_text_color": "#333333", "admin_brand_button_color": "#007AAA", "admin_brand_font_family": "Inter", "admin_brand_form_id": "58", "admin_org_name": "Global Education Trust", "admin_org_code": "GET-2026", "admin_org_type": "Academic Institution", "admin_org_registration_no": "REG123456789", "admin_org_gst_no": "27AAAAA0000A1Z5", "admin_org_pan_no": "ABCDE1234F", "admin_org_established_year": 2012, "admin_org_address_line1": "123 Innovation Drive", "admin_org_address_line2": "Cyber City", "admin_org_city": "Pune", "admin_org_district": "Pune", "admin_org_state": "Maharashtra", "admin_org_country": "India", "admin_org_pincode": "411045" } }' ``` > Responce: ```json '{ "status": "success", "message": "User created successfully.", "code": 200, "reg_number": "ORG-00014", "data": { "user_id": "560", "user_name": "ORG-00014", "first_name": "admin", "middle_name": "supraa", "last_name": "Sharma", "email": "balajjiadmin@gmail.com", "mobile": "9876543210", "role_id": "2", "parent_id": "330", "profile_img": { "media_id": "57", "media_src": "https://vedaay-api.mulika.in/media/src/57/1770458526_bottles1.jpeg", "media_alt": "main_file", "media_title": "main_file_form", "media_description": "file_format" }, "status": "active", "created_by": "330", "scope": "/330", "created_at": "2026-04-13 12:37:53", "updated_at": "2026-04-13 12:37:53", "role_name": "Admin", "details": { "admin_domain": "balajjiadmin-org.vedaay.mulika.in", "admin_brand_name": "blueadmin Pro", "admin_brand_tagline": "Empowering Education", "admin_brand_about_us": "A leading provider of educational management solutions.", "admin_brand_logo_url": "70", "admin_brand_favicon_url": "71", "admin_brand_banner_image_url": "66", "admin_brand_login_background_image": "69", "admin_brand_primary_color": "#4A90E2", "admin_brand_secondary_color": "#AAAA23", "admin_brand_text_color": "#333333", "admin_brand_button_color": "#007AAA", "admin_brand_font_family": "Inter", "admin_brand_form_id": "58", "admin_org_name": "Global Education Trust", "admin_org_code": "GET-2026", "admin_org_type": "Academic Institution", "admin_org_registration_no": "REG123456789", "admin_org_gst_no": "27AAAAA0000A1Z5", "admin_org_pan_no": "ABCDE1234F", "admin_org_established_year": 2012, "admin_org_address_line1": "123 Innovation Drive", "admin_org_address_line2": "Cyber City", "admin_org_city": "Pune", "admin_org_district": "Pune", "admin_org_state": "Maharashtra", "admin_org_country": "India", "admin_org_pincode": "411045", "admin_reg_number": "ORG-00014" } } }' ``` ### Admin Properties | Attributes | Type | Description |-----------------------------|---------------|-------------------------------------- | admin_domain | string | Admin domain name (e.g., example.com) | admin_brand_name | string | Admin brand name (e.g., EduSphere Pro) | admin_brand_tagline | string | Admin brand tagline | admin_brand_about_us | string | About us description for the brand | admin_brand_logo_url | string | media_id for brand logo | admin_brand_favicon_url | string | media_id for brand favicon | admin_brand_banner_image_url| string | media_id for brand banner image | admin_brand_login_background_image| string | media_id for login background image | admin_brand_primary_color | string | Primary brand color (hex) | admin_brand_secondary_color | string | Secondary brand color (hex) | admin_brand_text_color | string | Text color (hex) | admin_brand_button_color | string | Button color (hex) | admin_brand_font_family | string | Font family for branding | admin_brand_form_id | string | Franchise brand form id | admin_org_name | string | Organization name | admin_org_code | string | Organization code (e.g., GET-2026) | admin_org_type | string | Type of organization | admin_org_registration_no | string | Registration number | admin_org_gst_no | string | GST number | admin_org_pan_no | string | PAN number | admin_org_established_year | integer | Year organization was established | admin_org_address_line1 | string | Address line 1 | admin_org_address_line2 | string | Address line 2 | admin_org_city | string | City | admin_org_district | string | District | admin_org_state | string | State | admin_org_country | string | Country | admin_org_pincode | string | PIN code | admin_reg_number | string | admin_reg_number ## Parent POST /users ```shell curl -X PUT https://vedaay-api.mulika.in/users -H "Content-Type: application/json" \ -H Authorization: Bearer eyJ0eXAiOiJKNiJ9.B7Y3J9FWtgjby4P8-LX_Vkeob6CE -d '{ "user_name": "parewntuser27", "first_name": "shealbiyan", "middle_name": "supraa", "last_name": "sheaan", "email": "paraentuser27@gmail.com", "mobile": "9876543210", "password": "11111111", "role_id": 3, "parent_id": 302, "profile_img":70, "details": { "parent_address_line1": "Flat 202, Sunshine Apartments", "parent_address_line2": "Near Central Park", "parent_city": "Mumbai", "parent_state": "Maharashtra", "parent_country": "India", "parent_pincode": "400001", "parent_occupation": "Software Engineer", "parent_annual_income": "123456" } }' ``` > Responce: ```json '{ "status": "success", "message": "User created successfully.", "code": 200, "reg_number": "PAR-00029", "data": { "user_id": "565", "user_name": "PAR-00029", "first_name": "shealbiyan", "middle_name": "supraa", "last_name": "sheaan", "email": "paraentuser27@gmail.com", "mobile": "9876543210", "role_id": "3", "parent_id": "302", "profile_img": { "media_id": "70", "media_src": "https://vedaay-api.mulika.in/media/src/70/1772189405_logo_03.png", "media_tags": "image", "media_alt": "pinga", "media_title": "hokua", "media_description": "apksd" }, "status": "active", "created_by": "302", "scope": "/330/294/302", "created_at": "2026-04-13 12:48:50", "updated_at": "2026-04-13 12:48:50", "details": { "parent_address_line1": "Flat 202, Sunshine Apartments", "parent_address_line2": "Near Central Park", "parent_city": "Mumbai", "parent_state": "Maharashtra", "parent_country": "India", "parent_pincode": "400001", "parent_occupation": "Software Engineer", "parent_annual_income": "123456", "parent_reg_number": "PAR-00029" } } }' ``` ### Parent properties | Attributes | Type | Description |-------------------------|---------|------------------------- | parent_address_line1 | string | Parent's address line 1 | parent_address_line2 | string | Parent's address line 2 | parent_city | string | Parent's city | parent_state | string | Parent's state | parent_country | string | Parent's country | parent_pincode | string | Parent's PIN code | parent_occupation | string | Parent's occupation | parent_annual_income | string | Parent's annual income ## Student POST /users ```shell curl -X POST https://vedaay-api.mulika.in/users -H "Content-Type: application/json" \ -H Authorization: Bearer eyJ0eXAiOiJKNiJ9.B7Y3J9FWtgjby4P8-LX_Vkeob6CE -d '{ "user_name": "tejinfo", "first_name": "vishtejinfoal", "middle_name": "tejinfo", "last_name": "tejinfo", "email": "tejinfo@gmail.com", "mobile": "9876543210", "password": "11111111", "role_id": 4, "parent_id": 302, "profile_img": 70, "details": { "student_address_line1": "Flat 202, Sunshine Apartments", "student_address_line2": "Near Central Park", "student_city": "Mumbai", "student_state": "Maharashtra", "student_country": "India", "student_pincode": "400001", "student_parent_id": "PAR-9901", "student_parent_relation": "Father", "student_dob": "2012-05-15", "student_gender": "Male", "student_school_name": "St. Xavier's High School", "student_grade_class": "Class 8", "student_enrollment_date": "2026-01-10" } }' ``` > Responce: ```json '{ "status": "success", "message": "User created successfully.", "code": 200, "reg_number": "STD-302-2026-00025", "data": { "user_id": "566", "user_name": "STD-302-2026-00025", "first_name": "vishtejinfoal", "middle_name": "tejinfo", "last_name": "tejinfo", "email": "tejinfo@gmail.com", "mobile": "9876543210", "role_id": "4", "parent_id": "302", "profile_img": { "media_id": "70", "media_src": "https://vedaay-api.mulika.in/media/src/70/1772189405_logo_03.png", "media_tags": "image", "media_alt": "pinga", "media_title": "hokua", "media_description": "apksd" }, "status": "active", "created_by": "302", "scope": "/330/294/302", "created_at": "2026-04-13 12:56:00", "updated_at": "2026-04-13 12:56:00", "details": { "student_address_line1": "Flat 202, Sunshine Apartments", "student_address_line2": "Near Central Park", "student_city": "Mumbai", "student_state": "Maharashtra", "student_country": "India", "student_pincode": "400001", "student_parent_id": "PAR-9901", "student_parent_relation": "Father", "student_dob": "2012-05-15", "student_gender": "Male", "student_school_name": "St. Xavier's High School", "student_grade_class": "Class 8", "student_enrollment_date": "2026-01-10", "student_reg_number": "STD-302-2026-00025" } } }' ``` ### Student Properties | Attributes | Type | Description | |---------------------------|---------|--------------------------------------| | student_address_line1 | string | Student's address line 1 | | student_address_line2 | string | Student's address line 2 | | student_city | string | Student's city | | student_state | string | Student's state | | student_country | string | Student's country | | student_pincode | string | Student's PIN code | | student_parent_id | string | Parent ID (e.g., PAR-9901) | | student_parent_relation | string | Relation to parent (e.g., Father) | | student_dob | string | Date of birth (YYYY-MM-DD) | | student_gender | string | Student's gender | | student_school_name | string | School name | | student_grade_class | string | Current grade/class | | student_enrollment_date | string | Enrollment date (YYYY-MM-DD) | ## District_Franchise POST /users ```shell curl -X PUT https://vedaay-api.mulika.in/users -H "Content-Type: application/json" \ -H Authorization: Bearer eyJ0eXAiOiJKNiJ9.B7Y3J9FWtgjby4P8-LX_Vkeob6CE -d '{ "user_name": "gujratdist", "first_name": "backlspav", "middle_name": "enter", "last_name": "brown", "email": "gujratdist@gmail.com", "mobile": "9876543210", "password": "11111111", "role_id": 5, "parent_id": 294, "profile_img": 70, "details": { "franchise_address_line1": "Shop No. 12, Crystal sarvam", "franchise_address_line2": "Opposite Railway Station", "franchise_city": "Pune", "franchise_district": "Pune", "franchise_state": "Maharashtra", "franchise_country": "India", "franchise_pincode": "411011", "franchise_domain": "shirur-edu", "franchise_brand_name": "greendistrict Franchise", "franchise_brand_tagline": "Quality Learning in Every Corner", "franchise_brand_about_us": "Providing educational support across the Pune district.", "franchise_brand_logo_url": "66", "franchise_brand_favicon_url": "67", "franchise_brand_banner_image_url": "68", "franchise_brand_login_background_image": "69", "franchise_brand_primary_color": "#1A5276", "franchise_brand_secondary_color": "#D4AC0D", "franchise_brand_text_color": "#212121", "franchise_brand_button_color": "#2E86C1", "franchise_brand_font_family": "Roboto", "franchise_brand_form_id": "58", "franchise_name": "Bright Minds Unit 01", "franchise_area": "Viman Nagar", "franchise_gst_number": "27AAACU1234A1Z1", "franchise_agreement_start": "2026-05-01", "franchise_agreement_end": "2029-04-30" } }' ``` > Responce: ```json '{ "status": "success", "message": "User found.", "code": 200, "reg_number": "DFC-MH-PN-294-00020", "data": { "user_id": "557", "user_name": "DFC-MH-PN-294-00020", "first_name": "backlspav", "middle_name": "enter", "last_name": "brown", "email": "gujratdist@gmail.com", "mobile": "9876543210", "role_id": "5", "parent_id": "294", "profile_img": { "media_id": "70", "media_src": "https://vedaay-api.mulika.in/media/src/70/1772189405_logo_03.png", "media_tags": "image", "media_alt": "pinga", "media_title": "hokua", "media_description": "apksd" }, "status": "active", "created_by": "294", "scope": "/330/294", "created_at": "2026-04-09 10:00:59", "updated_at": "2026-04-09 10:00:59", "details": { "franchise_address_line1": "Shop No. 12, Crystal sarvam", "franchise_address_line2": "Opposite Railway Station", "franchise_city": "Pune", "franchise_district": "Pune", "franchise_state": "Maharashtra", "franchise_country": "India", "franchise_pincode": "411011", "franchise_domain": "shirur-edu", "franchise_brand_name": "greendistrict Franchise", "franchise_brand_tagline": "Quality Learning in Every Corner", "franchise_brand_about_us": "Providing educational support across the Pune district.", "franchise_brand_logo_url": "https://storage.link/franchise_logo.png", "franchise_brand_favicon_url": "https://storage.link/franchise_favicon.ico", "franchise_brand_banner_image_url": "https://storage.link/franchise_banner.jpg", "franchise_brand_login_background_image": "https://storage.link/franchise_bg.jpg", "franchise_brand_primary_color": "#1A5276", "franchise_brand_secondary_color": "#D4AC0D", "franchise_brand_text_color": "#212121", "franchise_brand_button_color": "#2E86C1", "franchise_brand_font_family": "Roboto", "franchise_brand_form_id": "58", "franchise_name": "Bright Minds Unit 01", "franchise_area": "Viman Nagar", "franchise_gst_number": "27AAACU1234A1Z1", "franchise_agreement_start": "2026-05-01", "franchise_agreement_end": "2029-04-30", "district_franchise_reg_number": "DFC-MH-PN-294-00020" } } }' ``` ### District franchise Properties | Attributes | Type | Description |------------------------------------------|---------|-------------------------------------------------- | franchise_address_line1 | string | Unit franchise address line 1 | franchise_address_line2 | string | Unit franchise address line 2 | franchise_city | string | Unit franchise city | franchise_district | string | Unit franchise district | franchise_state | string | Unit franchise state | franchise_country | string | Unit franchise country | franchise_pincode | string | Unit franchise PIN code | franchise_domain | string | Franchise domain | franchise_brand_name | string | Franchise brand name | franchise_brand_tagline | string | Franchise brand tagline | franchise_brand_about_us | string | Franchise brand about us description | franchise_brand_logo_url | string | media_id for brand logo | franchise_brand_favicon_url | string | media_id for brand favicon | franchise_brand_banner_image_url | string | media_id for brand banner image | franchise_brand_login_background_image | string | media_id for login background image | franchise_brand_primary_color | string | Franchise primary color (hex) | franchise_brand_secondary_color | string | Franchise secondary color (hex) | franchise_brand_text_color | string | Franchise text color (hex) | franchise_brand_button_color | string | Franchise button color (hex) | franchise_brand_font_family | string | Franchise brand font family | franchise_brand_form_id | string | Franchise brand form id | franchise_name | string | Unit franchise name | franchise_code | string | Unit franchise code | franchise_area | string | Unit franchise area/region | franchise_gst_number | string | Unit franchise GST number | franchise_agreement_start | string | Unit franchise agreement start date (YYYY-MM-DD) | franchise_agreement_end | string | Unit franchise agreement end date (YYYY-MM-DD) ## School_Franchise POST /users ```shell curl -X POST https://vedaay-api.mulika.in/users -H "Content-Type: application/json" \ -H Authorization: Bearer eyJ0eXAiOiJKNiJ9.B7Y3J9FWtgjby4P8-LX_Vkeob6CE -d '{ "user_name": "scheool100", "first_name": "backlspav", "middle_name": "enter", "last_name": "brown", "email": "scehool100@gmail.com", "mobile": "9876543210", "password": "11111111", "role_id": 6, "parent_id": 302, "profile_img": 55, "details": { "franchise_address_line1": "Shop No. 12, Crystal sarvam", "franchise_address_line2": "Opposite Railway Station", "franchise_city": "Pune", "franchise_district": "Pune", "franchise_state": "Maharashtra", "franchise_country": "India", "franchise_pincode": "411011", "franchise_domain": "edu-pune.com", "franchise_brand_name": "EduPune Franchise", "franchise_brand_tagline": "Quality Learning in Every Corner", "franchise_brand_about_us": "Providing educational support across the Pune district.", "franchise_brand_logo_url": "66", "franchise_brand_favicon_url": "67", "franchise_brand_banner_image_url": "68", "franchise_brand_login_background_image": "69", "franchise_brand_primary_color": "#1A5276", "franchise_brand_secondary_color": "#D4AC0D", "franchise_brand_text_color": "#212121", "franchise_brand_button_color": "#2E86C1", "franchise_brand_font_family": "Roboto", "franchise_brand_form_id": "58", "franchise_name": "Bright Minds Unit 01", "franchise_area": "Viman Nagar", "franchise_gst_number": "27AAACU1234A1Z1", "franchise_agreement_start": "2026-05-01", "franchise_agreement_end": "2029-04-30" } }' ``` > Responce: ```json '{ "status": "success", "message": "User created successfully.", "reg_number": "SH-MH-PN-302-00014", "code": 200, "data": { "user_id": "450", "user_name": "SH-MH-PN-302-00014", "first_name": "backlspav", "middle_name": "enter", "last_name": "brown", "email": "scehool100@gmail.com", "mobile": "9876543210", "role_id": "6", "parent_id": "302", "profile_img": { "media_id": "70", "media_src": "https://vedaay-api.mulika.in/media/src/70/1772189405_logo_03.png", "media_alt": "pinga", "media_title": "hokua", "media_description": "apksd" }, "status": "active", "created_by": "302", "scope": "/330/294/302", "created_at": "2026-02-27 18:34:59", "updated_at": "2026-02-27 18:34:59", "role_name": "School franchise", "details": { "franchise_address_line1": "Shop No. 12, Crystal sarvam", "franchise_address_line2": "Opposite Railway Station", "franchise_city": "Pune", "franchise_district": "Pune", "franchise_state": "Maharashtra", "franchise_country": "India", "franchise_pincode": "411011", "franchise_domain": "edu-pune.com", "franchise_brand_name": "EduPune Franchisee", "franchise_brand_tagline": "Quality Learning in Every Corner", "franchise_brand_about_us": "Providing educational support across the Pune district.", "franchise_brand_logo_url": "66", "franchise_brand_favicon_url": "67", "franchise_brand_banner_image_url": "68", "franchise_brand_login_background_image": "69", "franchise_brand_primary_color": "#1A5276", "franchise_brand_secondary_color": "#D4AC0D", "franchise_brand_text_color": "#212121", "franchise_brand_button_color": "#2E86C1", "franchise_brand_font_family": "Roboto", "franchise_brand_form_id": "58", "franchise_name": "Bright Minds Unit 01", "franchise_area": "Viman Nagar", "franchise_gst_number": "27AAACU1234A1Z1", "franchise_agreement_start": "2026-05-01", "franchise_agreement_end": "2029-04-30", "school_franchise_reg_number": "SH-MH-PN-302-00014" } } }' ``` ### School franchise Properties | Attributes | Type | Description |------------------------------------------|---------|-------------------------------------------------- | franchise_address_line1 | string | Unit franchise address line 1 | franchise_address_line2 | string | Unit franchise address line 2 | franchise_city | string | Unit franchise city | franchise_district | string | Unit franchise district | franchise_state | string | Unit franchise state | franchise_country | string | Unit franchise country | franchise_pincode | string | Unit franchise PIN code | franchise_domain | string | Franchise domain | franchise_brand_name | string | Franchise brand name | franchise_brand_tagline | string | Franchise brand tagline | franchise_brand_about_us | string | Franchise brand about us description | franchise_brand_logo_url | string | media_id brand logo | franchise_brand_favicon_url | string | media_id brand favicon | franchise_brand_banner_image_url | string | media_id brand banner image | franchise_brand_login_background_image | string | media_id login background image | franchise_brand_primary_color | string | Franchise primary color (hex) | franchise_brand_secondary_color | string | Franchise secondary color (hex) | franchise_brand_text_color | string | Franchise text color (hex) | franchise_brand_button_color | string | Franchise button color (hex) | franchise_brand_font_family | string | Franchise brand font family | franchise_brand_form_id | string | Franchise brand form id | franchise_name | string | Unit franchise name | franchise_area | string | Unit franchise area/region | franchise_gst_number | string | Unit franchise GST number | franchise_agreement_start | string | Unit franchise agreement start date (YYYY-MM-DD) | franchise_agreement_end | string | Unit franchise agreement end date (YYYY-MM-DD) ## Unit_Franchise POST /users ```shell curl -X PUT https://vedaay-api.mulika.in/users/139 -H "Content-Type: application/json" \ -H Authorization: Bearer eyJ0eXAiOiJKNiJ9.B7Y3J9FWtgjby4P8-LX_Vkeob6CE -d '{ "user_name": "unit1", "first_name": "backlspav", "middle_name": "enter", "last_name": "brown", "email": "unit1@gmail.com", "mobile": "9876543210", "password": "11111111", "role_id": 7, "parent_id": 107, "profile_img": 55, "details": { "franchise_address_line1": "Shop No. 12, Crystal sarvam", "franchise_address_line2": "Opposite Railway Station", "franchise_city": "Pune", "franchise_district": "Pune", "franchise_state": "Maharashtra", "franchise_country": "India", "franchise_pincode": "411011", "franchise_domain": "edu-pune.com", "franchise_brand_name": "EduPune Franchise", "franchise_brand_tagline": "Quality Learning in Every Corner", "franchise_brand_about_us": "Providing educational support across the Pune district.", "franchise_brand_logo_url": "66", "franchise_brand_favicon_url": "67", "franchise_brand_banner_image_url": "68", "franchise_brand_login_background_image": "69", "franchise_brand_primary_color": "#1A5276", "franchise_brand_secondary_color": "#D4AC0D", "franchise_brand_text_color": "#212121", "franchise_brand_button_color": "#2E86C1", "franchise_brand_font_family": "Roboto", "franchise_brand_form_id": "58", "franchise_name": "Bright Minds Unit 01", "franchise_area": "Viman Nagar", "franchise_gst_number": "27AAACU1234A1Z1", "franchise_agreement_start": "2026-05-01", "franchise_agreement_end": "2029-04-30" } }' ``` > Responce: ```json { "status": "success", "message": "User created successfully.", "code": 200, "reg_number": "UN-MH-PN-107-00030", "data": { "user_id": "571", "user_name": "UN-MH-PN-107-00030", "first_name": "backlspav", "middle_name": "enter", "last_name": "brown", "email": "uniwdtfdrechi19@gmail.com", "mobile": "9876543210", "role_id": "7", "parent_id": "107", "profile_img": { "media_id": "70", "media_src": "https://vedaay-api.mulika.in/media/src/70/1772189405_logo_03.png", "media_tags": "image", "media_alt": "pinga", "media_title": "hokua", "media_description": "apksd" }, "status": "active", "created_by": "107", "scope": "/330/107", "created_at": "2026-04-17 18:24:42", "updated_at": "2026-04-17 18:24:42", "details": { "franchise_address_line1": "Shop No. 12, Crystal sarvam", "franchise_address_line2": "Opposite Railway Station", "franchise_city": "Pune", "franchise_district": "Pune", "franchise_state": "Maharashtra", "franchise_country": "India", "franchise_pincode": "411011", "franchise_domain": "stjoseph-org", "franchise_brand_name": "EduPune Franchise", "franchise_brand_tagline": "Quality Learning in Every Corner", "franchise_brand_about_us": "Providing educational support across the Pune district.", "franchise_brand_logo_url": "66", "franchise_brand_favicon_url": "67", "franchise_brand_banner_image_url": "68", "franchise_brand_login_background_image": "69", "franchise_brand_primary_color": "#1A5276", "franchise_brand_secondary_color": "#D4AC0D", "franchise_brand_text_color": "#212121", "franchise_brand_button_color": "#2E86C1", "franchise_brand_font_family": "Roboto", "franchise_name": "Bright Minds Unit 01", "franchise_area": "Viman Nagar", "franchise_gst_number": "27AAACU1234A1Z1", "franchise_agreement_start": "2026-05-01", "franchise_agreement_end": "2029-04-30", "unit_franchise_reg_number": "UN-MH-PN-107-00030" } } }' ``` ### Unit franchise Properties | Attributes | Type | Description |------------------------------------------|---------|-------------------------------------------------- | franchise_address_line1 | string | Unit franchise address line 1 | franchise_address_line2 | string | Unit franchise address line 2 | franchise_city | string | Unit franchise city | franchise_district | string | Unit franchise district | franchise_state | string | Unit franchise state | franchise_country | string | Unit franchise country | franchise_pincode | string | Unit franchise PIN code | franchise_domain | string | Franchise domain | franchise_brand_name | string | Franchise brand name | franchise_brand_tagline | string | Franchise brand tagline | franchise_brand_about_us | string | Franchise brand about us description | franchise_brand_logo_url | string | media_id brand logo | franchise_brand_favicon_url | string | media_id brand favicon | franchise_brand_banner_image_url | string | media_id brand banner image | franchise_brand_login_background_image | string | media_id login background image | franchise_brand_primary_color | string | Franchise primary color (hex) | franchise_brand_secondary_color | string | Franchise secondary color (hex) | franchise_brand_text_color | string | Franchise text color (hex) | franchise_brand_button_color | string | Franchise button color (hex) | franchise_brand_font_family | string | Franchise brand font family | franchise_brand_form_id | string | Franchise brand form id | franchise_name | string | Unit franchise name | franchise_area | string | Unit franchise area/region | franchise_gst_number | string | Unit franchise GST number | franchise_agreement_start | string | Unit franchise agreement start date (YYYY-MM-DD) | franchise_agreement_end | string | Unit franchise agreement end date (YYYY-MM-DD) ## Teacher POST /users ```shell curl -X POST https://vedaay-api.mulika.in/users -H "Content-Type: application/json" \ -H Authorization: Bearer eyJ0eXAiOiJKNiJ9.B7Y3J9FWtgjby4P8-LX_Vkeob6CE -d '{ "user_name": "supraa", "first_name": "supraa", "middle_name": "supraa", "last_name": "Sharma", "email": "bluewhales@example.com", "mobile": "9876543210", "password": "11111111", "role_id": 8, "parent_id": 151, "profile_img": 55, "details": { "teacher_address_line1": "wikens Educator Blvd", "teacher_address_line2": "Suite 10, Learn Town", "teacher_city": "Pune", "teacher_state": "Maharashtra", "teacher_country": "India", "teacher_pincode": "411001", "teacher_qualification": "M.Sc. Mathematics", "teacher_experience_years": 5, "teacher_specialization_subjects": "Algebra", "teacher_employment_type": "Full-time", "teacher_joining_date": "2026-02-01" } }' ``` > Responce: ```json { "status": "success", "message": "User created successfully.", "code": 200, "reg_number": "TEA-00016", "data": { "user_id": "306", "user_name": "TEA-00016", "first_name": "squidgameer", "middle_name": "sxfquid", "last_name": "Sharmam", "email": "veerenkd@gmail.com", "mobile": "9876543215", "role_id": "8", "parent_id": "155", "profile_img": { "media_id": "55", "media_src": "https://vedaay-api.mulika.in/media/src/55/1769837204_om.png", "media_tags": "image", "media_alt": "om storage", "media_title": "om storage", "media_description": "om storage" }, "status": "inactive", "created_by": "151", "scope": "/330/107/151", "created_at": "2026-02-11 10:18:50", "updated_at": "2026-03-05 18:02:08", "details": { "teacher_address_line1": "squid Educator Blvd", "teacher_address_line2": "Suite 10, Learn Town", "teacher_city": "Pune", "teacher_state": "Maharashtra", "teacher_country": "India", "teacher_pincode": "411001", "teacher_qualification": "M.Sc. Mathematics", "teacher_experience_years": "55", "teacher_specialization_subjects": "Algebra", "teacher_employment_type": "Full-time", "teacher_joining_date": "2026-02-01", "teacher_reg_number": "TEA-00016" } } }' ``` ### Teacher Properties | Attributes | Type | Description | |--------------------------------|------------------|--------------------------------------------------| | teacher_address_line1 | string | Teacher's address line 1 | | teacher_address_line2 | string | Teacher's address line 2 | | teacher_city | string | Teacher's city | | teacher_state | string | Teacher's state | | teacher_country | string | Teacher's country | | teacher_pincode | string | Teacher's PIN code | | teacher_qualification | string | Teacher's qualification | | teacher_experience_years | integer | Years of teaching experience | | teacher_specialization_subjects| array (string) | Subjects teacher specializes in | | teacher_employment_type | string | Employment type (Full-time/Part-time) | | teacher_joining_date | string | Date teacher joined (YYYY-MM-DD) | ## Register user verification ## Send registeration otp ```shell curl -X POST https://vedaay-api.mulika.in/send_reg_otp -H "Content-Type: application/json" \ -d '{ "email": "praful@gmail.com" }' ``` > Responce: ```json '{ "status": "success", "message": "OTP generated.", "code": 200, "email": "praful@gmail.com", "debug_otp": "495587" }' ``` POST /send_reg_otp ## Verify registeration otp ```shell curl -X POST https://vedaay-api.mulika.in/verify_reg_otp -H "Content-Type: application/json" \ -d '{ "email": "praful@gmail.com", "otp" : "495587" }' ``` > Responce: ```json '{ "status": "success", "message": "Email verified successfully.", "code": 200, "email": "praful@gmail.com" }' ``` POST /verify_reg_otp