Back to reference
POST/auth/employee/login
Authentication

Business employee login

Authenticates a business employee using business scope plus email/phone and password.

Access tierpublicRate limitpay_apiIdempotencynoneAuthenticationPublic
SourceLuxApi/Modules/LuxPayIdentity/Http/Controllers/Api/UserAuthController.php::employeeLoginLuxPayProjects @ 146e98baa44e

Parameters

X-Request-IDheader
stringOptional

Client correlation identifier. LuxPay may generate one when omitted.

Example: req_01J...

Request body

EmployeeLoginRequestRequired
business_id
integer | null
Example: 10101
business_number
string | null
Example: FT-10101
email
string
Example: employee@example.com
password
string

JSON example

"string"

Code examples

The displayed sandbox host is a placeholder until an official host is provisioned. Never paste a production token into a public browser.
curl --request POST \
  --url 'https://sandbox-api.luxpay.example/v1/auth/employee/login' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data '"string"'

Responses

200Successful response.
success
boolean
Example: true
token
string
user
BusinessUser
business
Business
{
  "success": true,
  "token": "string",
  "user": {
    "id": 1,
    "full_name": "string",
    "email": "string",
    "is_owner": false
  },
  "business": {
    "id": 1,
    "legal_name": "string",
    "business_number": "string"
  }
}
400
401
403
404
409
422
429
500
OpenAPI JSONOpenAPI YAMLPostman collection