Profile Check
Retrieve information about your current user profile, balance, and account limits.
Endpoint Features
The Profile check endpoint allows you to programmatically fetch your latest balance in both BDT and USD (with dynamic exchange rates), check your rank status (Bronze, Silver, Gold, Platinum) and calculate progress towards your next rank upgrade.
Authentication
Requires Authorization header with a Bearer API token.
Response Attributes
| Field | Type | Description |
|---|---|---|
| status | string | Always returns "success" or "error". |
| data | object | The main payload containing all profile information. |
| data.user | object | Contains id, full_name, username, email, avatar |
| data.wallet | object | Returns real-time balance_bdt and balance_usd. |
| data.rank_info | object | Insights on current VIP rank, necessary deposit needed for next rank, and visual badge URL. |
| data.account_stats | object | Contains total_orders, total_deposits, and registration_date. |
Error Codes
- 401 Unauthorized: Missing or invalid API Key.
- 404 Not Found: User account was suspended or deleted.
Interactive Testing
Enter your API key into the top bar, then press the Try It button to fetch your live profile straight from the HS Mail ecosystem.
Headers:Authorization: (Not Set - Set in Topbar)