Login

Authenticate and receive a JWT access token.

POST /v1/auth/login

cURL

curl --request POST \
  --url https://api.paypulse.io/v1/auth/login \
  --header 'Content-Type: application/json' \
  --data '{
    "email": "[e-mail]",
    "password": "s3cur3P@ssword!"
  }'

200

{
  "message": "Login successful!",
  "code": 200,
  "data": {
    "username": "Jane Doe",
    "access_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
    "token_type": "Bearer"
  }
}

{
  "error": {
    "code": "INVALID_CREDENTIALS",
    "message": "Invalid Credentials"
  }
}

{
  "error": {
    "code": "USER_NOT_FOUND",
    "message": "User not found"
  }
}

Request body

email · string · required

The email address associated with the account.

password · string · required

The account password.

Response

message · string

A human-readable confirmation message. Example: "Login successful!"

code · number

HTTP status code. 200 on success.

data · object

Hide properties

username · string

The display name associated with the authenticated account.

access_token · string

A signed HS256 JWT token valid for 1 hour.

token_type · string

Always "Bearer".

Include the access_token in the Authorization header of all subsequent requests that require authentication: Authorization: Bearer <access_token>.

Error responses

Status	Error code	Description
400	INVALID_JSON	The request body is not valid JSON.
400	MISSING_FIELDS	One or more required fields (email, password) are absent.
401	INVALID_CREDENTIALS	The password does not match the stored credential.
404	USER_NOT_FOUND	No account exists for the given email address.
500	JWT_ERROR	The server failed to generate the JWT token.
500	INTERNAL_SERVER_ERROR	An unexpected server-side error occurred.

Error responses follow this structure:

{
  "error": {
    "code": "INVALID_CREDENTIALS",
    "message": "Invalid Credentials"
  }
}

cURL

curl --request POST \
  --url https://api.paypulse.io/v1/auth/login \
  --header 'Content-Type: application/json' \
  --data '{
    "email": "[e-mail]",
    "password": "s3cur3P@ssword!"
  }'

200

{
  "message": "Login successful!",
  "code": 200,
  "data": {
    "username": "Jane Doe",
    "access_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
    "token_type": "Bearer"
  }
}

{
  "error": {
    "code": "INVALID_CREDENTIALS",
    "message": "Invalid Credentials"
  }
}

{
  "error": {
    "code": "USER_NOT_FOUND",
    "message": "User not found"
  }
}