Skip to main content
PUT
Login
Authenticate users with email and password to obtain JWT access and refresh tokens. This endpoint supports all user roles: MANAGER, AGENT, CASHIER, and CUSTOMER, etc.

Request Headers

Content-Type
string
default:"application/json"
required
  Must be application/json
platform
string
default:"fincode"
required
  Platform identifier. Use fincode
uuid
string
default:"200"
required
  Unique request identifier. Use 200

Request Body

email
string
required
    User’s email address registered in the system
currentPassword
string
required
    User’s password (minimum 8 characters)

Code Examples


Error Handling

Cause: Email or password is incorrectSolution:
  • Verify email address is correct
  • Check password is entered correctly
  • Use password reset if forgotten
  • Contact support if issue persists
Cause: Multiple failed login attemptsSolution:
  • Wait for the lockout period to expire
  • Contact your administrator to unlock the account
  • Use the “Forgot Password” flow to reset password
Cause: Email address not registered in the systemSolution:
  • Verify the email address
  • Check if the user exists in your tenant
  • Contact administrator to create the user account

Best Practices

Token Storage

  • Store tokens securely (encrypted storage)
  • Use environment variables for tokens
  • Clear tokens on logout

Token Refresh

  • Implement automatic token refresh
  • Refresh before expiration (5 min buffer)

Error Handling

  • Implement retry logic
  • User-friendly messages

Security

  • CSRF protection
  • Set secure cookie flags

Testing in Sandbox

Use these test credentials in your sandbox environment:
These credentials only work in sandbox. Never use test credentials in production.

Headers

platform
string
default:fincode
required
uuid
string
default:200
required

Body

application/json
email
string
required
currentPassword
string
required

Response

200

Successful login