Skip to main content
POST
/
api
/
auth
/
login
Authenticate user
curl --request POST \
  --url https://sandbox.finhub.cloud/api/auth/login \
  --header 'Content-Type: application/json' \
  --header 'X-Forwarded-From: <x-forwarded-from>' \
  --header 'deviceId: <deviceid>' \
  --header 'platform: <platform>' \
  --data '
{
  "email": "admin@example.test",
  "password": "SecurePass123!",
  "tenantId": "tenant-demo-001",
  "captchaToken": "captcha-token-sample"
}
'
{
  "code": 200,
  "data": {
    "id": "123e4567-e89b-12d3-a456-426614174000"
  },
  "message": "Success"
}

Headers

User-Agent
string
X-Forwarded-For
string
Example:

"127.0.0.1"

X-Tenant-ID
string
Example:

"tenant-demo-001"

sec-ch-ua-platform
string
X-Forwarded-From
string
required

Client source identifier

Example:

"client-app"

platform
string
required

Client platform

Example:

"mobile"

deviceId
string
required

Device identifier

Example:

"device-demo-001"

Body

application/json
email
string

Login email

Example:

"admin@example.test"

password
string

Login password

Example:

"SecurePass123!"

tenantId
string

Tenant identifier

Example:

"tenant-demo-001"

captchaToken
string

Optional captcha token

Example:

"captcha-token-sample"

Response

200 - application/json

OK

Standard API response wrapper

code
integer<int32>

HTTP-style status code

Example:

200

data
object

Response payload object

Example:
{
"id": "123e4567-e89b-12d3-a456-426614174000"
}
message
string

Result message

Example:

"Success"