Login

Authenticate a user to obtain access and refresh tokens. Supports both traditional email/password login and social platform authentication (Google, Apple).

Endpoint

POST/user/v1/login

Security

Caution

This endpoint handles sensitive credentials. Ensure all requests are made over HTTPS.

Request Body

Email Login

{
  "email_login": {
    "email": "user@example.com",
    "password": "securepassword123"
  }
}

Social Login

{
  "social_login": {
    "token": "SOCIAL_ID_TOKEN",
    "platform": "GOOGLE"
  }
}

Constraints

Field	Requirement
email	Must be a valid email address format.
password	Must be between 8 and 16 characters in length.
platform	SocialPlatform: GOOGLE, APPLE.

Response Body

Success 200

{
"status": {
"type": "SUCCESS",
"details": []
},
"access_token": "eyJhbG...",
"refresh_token": "def456...",
"token_expiry": "2026-04-18T12:00:00Z",
"user_profile": {
"user_name": "jdoe",
"email": "user@example.com",
"first_name": "John",
"last_name": "Doe",
"user_status": "ACTIVE"
}
}

Error 400/500

{
"status": {
"type": "ERROR",
"details": [
  {
    "code": "401",
    "message": "Unauthorized access token."
  }
]
}
}

Response Fields

Field	Type	Description
status	Status	Operation status.
access_token	string	JWT used to authenticate subsequent API requests.
refresh_token	string	Token used to obtain new access tokens.
token_expiry	Timestamp	Expiration time for the access token.
user_profile	UserInfo	Detailed user profile.