Login

Description¶

The login endpoint is used to Sign in a user into the VELA application.

Request¶

Endpoint

/ui/v1/login

Method

POST

Header

Content-Type: application/json

Attributes

ELEMENT	DESCRIPTION
Username	Required Can be username, email, or Mobile Number
Password	Required
MerchantCode	Required specific code used for each merchant

Request Body : Login via Username

{
    "userName": "johnsmith",
    "password": "Password1!",
    "merchantCode": "VELA"
}

Request Body : Login via Email address

{
    "userName": "johnsmith@gmail.com",
    "password": "Password1!",
    "merchantCode": "VELA"
}

Request Body : Login via Mobile Number

{
    "userName": "4567899876",
    "password": "Password1!",
    "merchantCode": "VELA"
}

Request Body : Login via Mobile Number - Multiple accounts with same mobile number

{
    "password": "Vela1!",
    "userName": "123456789",
    "merchantCode": "VELA",
    "mobileCountryCallingCodeId": 1

}

Response¶

{
    "message": {
        "code": "28",
        "type": {
            "value": "Success",
            "name": "SUCCESS"
        },
        "text": null,
        "include_i_icon": false,
        "description": "You have been successfully authenticated."
    },
    "locationPath": "home",
    "userId": 195,
    "channelId": 49,
    "userRoles": "MERCHANT_ADMIN",
    "forceChangePasswordInd": false,
    "userLocale": "en_US",
    "passwordExpiryDaysIn": -1,
    "securityQuestionsEnrolledInd": true,
    "userEmail": "vela.madmin@gmail.com",
    "mobile": null,
    "loyaltyStatus": {
        "value": "Not Enrolled",
        "name": "NOT_ENROLLED"
    },
    "loyaltyRewardsNumber": null,
    "uiType": null,
    "createdUserId": 1,
    "unpaidInvoiceCount": 0,
    "acceptTermsOfUseAgreementInd": true,
    "acceptPrivacyPolicyAgreementInd": true,
    "roleType": null,
    "paymentAction": null,
    "merchantId": null,
    "invoiceNumber": null
}

Negative Request & Response

If a negative request has been passed for example with incorrect password, then the Response would be as follows:

Request Body

{
    "userName": "johnsmith",
    "password": "Password",
    "merchantCode: "VELA"
}

Response

{
    "message": {
        "code": "135",
        "type": {
            "value": "Error",
            "name": "ERROR"
        },
        "text": null,
        "include_i_icon": false,
        "description": "Your Login Credentials are invalid. You have <strong>6</strong> more attempt(s) remaining. Please double-check for a typo, and try again or click Forgot Username/Password or contact customer service."
    },
    "locationPath": null,
    "userId": null,
    "channelId": null,
    "userRoles": null,
    "forceChangePasswordInd": false,
    "userLocale": null,
    "passwordExpiryDaysIn": null,
    "securityQuestionsEnrolledInd": false,
    "userEmail": null,
    "mobile": null,
    "loyaltyStatus": {
        "value": "Not Enrolled",
        "name": "NOT_ENROLLED"
    },
    "loyaltyRewardsNumber": null,
    "uiType": null,
    "createdUserId": null,
    "unpaidInvoiceCount": null,
    "acceptTermsOfUseAgreementInd": false,
    "acceptPrivacyPolicyAgreementInd": false,
    "roleType": null,
    "paymentAction": null,
    "merchantId": null,
    "invoiceNumber": null
}

Updated As Of Version 5.3.1