User Guide

User Endpoints

All user routes require authenticated session context:

• GET /user/me
• PATCH /user/referral-code
• GET /user/referral-link
• POST /user/referrals/apply
• GET /user/referrals
• GET /user/rewards
• GET /user/leaderboard
• POST /user/claim
• POST /user/rewards/:rewardId/claim

Referral Identity Rules

• A user cannot apply their own referral code.
• A user can only be referred once.
• Referral code aliases must be 3 to 30 characters.
• Referral link format is generated from REFERRAL_BASE_URL as /register?ref=<code>.

Reward Visibility

GET /user/rewards supports optional status filtering:

• PENDING
• CLAIMABLE
• PROCESSING
• CLAIMED
• EXPIRED

Use Rewards and Claims for claim execution details.