1. Authentication
ProfitFlow
  • Account
    • Authentication
      • Login
        POST
      • Register new user
        POST
      • Get current user
        GET
      • Logout
        POST
      • Refresh token
        POST
    • Password
      • Request password reset
      • Reset password
      • Change password
    • Profile
      • Update current user
    • Delete account
      DELETE
  • Categories
    • List categories
      GET
    • Get category
      GET
  • Units
    • List available units
      GET
    • Get unit details
      GET
  • Investors
    • List investors
      GET
    • Get investor details
      GET
    • Get investor portfolio
      GET
  • Investment Requests
    • Create investment request
      POST
    • List investment requests
      GET
  • Portfolio
    • Get portfolio performance
      GET
    • Get transaction details
      GET
    • List transactions
      GET
  • KYC
    • List uploaded documents
      GET
    • Upload identity document
      POST
    • Get KYC status
      GET
  • Dashboard
    • Get investment marketplace
  • Distributions
    • List distributions
    • Get distribution details
    • List payouts
    • Get payout details
  • Statements
    • Download profit statement
    • Download tax records
    • Download portfolio summary
  • Notifications
    • List notifications
    • Get notification
    • Mark notification as read
    • Mark all as read
    • Register FCM token
    • Clear FCM token
  • Settings
    • Get app settings
    • Update app settings
  • Legal
    • Get privacy policy
    • Get terms of service
    • Get investment disclaimer
  • Marketplace
    • Get app configuration
  • Withdrawal Requests
    • Create withdrawal request
    • List withdrawal requests
  • Category Memberships
    • List memberships
    • Create membership
    • Available categories for enrollment
    • Get membership details
  • Public
    • Browse investment units (guest)
    • View unit details (guest)
    • Browse investment categories (guest)
    • View category details (guest)
  • Schemas
    • User
    • Category
    • Error
    • Unit
    • Investor
    • ValidationError
    • Portfolio
    • PaginationLinks
    • PaginationMeta
    • UnitDetail
    • InvestmentRequest
    • PublicUnit
    • InvestmentRequestWithUnit
    • Notification
    • WithdrawalRequest
    • CategoryMembership
    • Transaction
    • NotificationDataPayloads
    • WithdrawalRequestWithUnit
    • TransactionDetail
    • RegisterFcmTokenRequest
    • PortfolioPerformance
    • KycDocument
    • KycStatus
    • Dashboard
    • DashboardTrend
    • DashboardActivity
    • Marketplace
    • Distribution
    • FeaturedCategory
    • Payout
    • SimpleCategory
    • Settings
    • TopGainerUnit
    • NotificationSettings
    • NewListingUnit
    • LegalContent
    • AppConfig
    • IconOption
    • BadgeOption
    • ColorOption
    • PublicCategory
  1. Authentication

Login

POST
/auth/login
Authenticate an investor and receive an access token.
Note: Only users with the investor role can login via this API.
Admin users will receive a 401 Unauthorized response.

Request

Body Params application/jsonRequired

Example
{
    "email": "ahmed@profitflow.com",
    "password": "Investor@2026!"
}

Responses

🟢200
application/json
Login successful
Body

Example
{
    "message": "Login successful.",
    "user": {
        "id": 1,
        "name": "Ahmed Al-Rashid",
        "email": "ahmed@profitflow.com",
        "phone": "+966501234567",
        "locale": "en",
        "created_at": "2024-01-15T10:30:00+00:00",
        "updated_at": "2024-01-20T14:45:00+00:00"
    },
    "token": "1|abc123def456..."
}
🟠401
🟠422
Modified at 2026-03-12 00:48:26
Next
Register new user
Built with