POST UserLogin/Authenticate

Request Information

URI Parameters

None.

Body Parameters

UserLoginRequest
NameDescriptionTypeAdditional information
username

string

Required

password

string

Required

appversion

string

Required

source

string

Required

mobiledevicedetails

string

None.

imei

string

None.

location

string

None.

devicemanufacturer

string

None.

deviceplatform

string

None.

mobiledeviceid

string

None.

deviceserial

string

None.

deviceversion

string

None.

updatedevice

boolean

None.

devicechangeauthtype

string

None.

Otp

string

None.

token

string

None.

pushid

string

None.

RequestId

string

Required

UniqueDeviceId

string

None.

SessionId

string

None.

Request Formats

application/json, text/json

Sample:
{
  "username": "sample string 1",
  "password": "sample string 2",
  "appversion": "sample string 3",
  "source": "sample string 4",
  "mobiledevicedetails": "sample string 5",
  "imei": "sample string 6",
  "location": "sample string 7",
  "devicemanufacturer": "sample string 8",
  "deviceplatform": "sample string 9",
  "mobiledeviceid": "sample string 10",
  "deviceserial": "sample string 11",
  "deviceversion": "sample string 12",
  "updatedevice": true,
  "devicechangeauthtype": "sample string 14",
  "Otp": "sample string 15",
  "token": "sample string 16",
  "pushid": "sample string 17",
  "RequestId": "sample string 18",
  "UniqueDeviceId": "sample string 19",
  "SessionId": "sample string 20"
}

Response Information

Resource Description

UserAuthResponse
NameDescriptionTypeAdditional information
jWTTokenResponse

JWTTokenResponse

None.

RequestID

string

None.

ResponseCode

string

None.

ResponseDescription

string

None.

EnrollmentId

integer

None.

AccountNumber

string

None.

toolTip

string

None.

Response Formats

application/json, text/json

Sample:
{
  "jWTTokenResponse": {
    "Token": "sample string 1",
    "TokenExpiryDate": "2026-04-17T09:22:20.4281937+01:00",
    "Name": "sample string 2",
    "Branches": [
      "sample string 1",
      "sample string 2"
    ],
    "Permissions": [
      "sample string 1",
      "sample string 2"
    ],
    "Email": "sample string 3",
    "UserRole": "sample string 4",
    "BranchList": [
      {
        "Page": 1,
        "Key": 2,
        "code": "sample string 3",
        "Value": "sample string 4"
      },
      {
        "Page": 1,
        "Key": 2,
        "code": "sample string 3",
        "Value": "sample string 4"
      }
    ],
    "TokenId": "sample string 5"
  },
  "RequestID": "sample string 1",
  "ResponseCode": "sample string 2",
  "ResponseDescription": "sample string 3",
  "EnrollmentId": 4,
  "AccountNumber": "sample string 5",
  "toolTip": "sample string 6"
}