Rider Documentation
Complete guide to Rider features, access & system behaviour
Access & Permissions
Tier System
Affiliate Program
Wallet & Surveys
KYC & Fraud
Gamification
Access & Permissions Overview
Riders exist within a role-based access system. The platform has four main user roles: admin, rider (user), merchant, and sponsor. Riders use role user.
| Feature | Unapproved Rider | Approved Rider |
|---|---|---|
| Rider Dashboard | ❌ Blocked by ApprovalGuard | ✅ Full access |
| Survey Submissions | ❌ Not accessible | ✅ Can complete & earn |
| Wallet / Earnings | ❌ Not accessible | ✅ Full access |
| Shop (buying) | ✅ Can browse & buy | ✅ Can browse & buy |
| Affiliate Program | ✅ Can join | ✅ Can join |
| Loyalty Card | ❌ Not issued | ✅ Issued after KYC |
| CV Builder | ✅ Accessible | ✅ Accessible |
| Finance Tracker | ✅ Accessible | ✅ Accessible |
| Forum & Stories | ✅ Accessible | ✅ Accessible |
| Gamification / Badges | ❌ Not accessible | ✅ Full access |
Approval Flow
1
Registration
Rider fills out the 'Join Us' form with name, phone, CNIC, city, vehicle type, and email.
2
Admin Review
Admin sees the submission in AdminApprovals. Can approve, reject, or request changes.
3
Account Activated
Upon approval, rider gains full dashboard access. A Member entity is created automatically.
4
KYC Verification
Admin can further verify CNIC and identity, elevating the rider to kyc_verified=true status.
Riders with status: suspended or status: blacklisted cannot log in to the rider portal and are blocked by the ApprovalGuard component. Their wallet is also frozen automatically.
Rider Data Entities
| Entity | Purpose | Key Fields |
|---|---|---|
| Rider | Core rider profile | name, phone, cnic, city, vehicle_type, kyc_status, status, fraud_score |
| Member | Extended membership data | member_type, tier, loyalty_points, active_card_id, kyc_verified |
| Wallet | Financial balance | balance, total_credits, total_debits, is_frozen |
| WalletTransaction | Transaction ledger | amount, type, source, description, balance_after |
| RiderCV | Professional CV data | work_experience, education, languages, certifications |
| RiderFinanceEntry | Personal finance tracker | type, category, amount, entry_date, is_settled |
| Card | Physical loyalty card | number, status, issued_date, expiry_date |
| FraudLog | Fraud alerts | type, severity, action_taken, resolved |