First Time User Registration

The First Time User Registration APIs allows a user to update the email, password, as well as set up security Q&A.

Step 1: Change Password & Email

Description

The updateUserPwdAndEmail endpoint is used to register a user into the VELA application.

Request

Endpoint

/ui/v1/updateUserPwdAndEmail

Method

POST

Header

Content-Type: application/json

Request Body

{
    "id": "513",
    "status": {
        "name": "ACTIVE"
    },
    "userName": "Merchantuser.2020",
    "currentPwd": "",
    "newPwd": "",
    "reenterPwd": "",
    "pwdMisMatchError": false,
    "newPwdStrengthError": false,
    "reEnterPwdStrengthError": false,
    "currentPwdMisMatchError": false,
    "pwdLengthError": false,
    "pwdInHistoryError": false,
    "passwordExpiredInd": "false",
    "minimumPasswordLength": "6",
    "pwdStrengthPercentage": 0,
    "reEnterPwdStrengthPercentage": 0,
    "securityQuestionsEnrolledInd": false,
    "passwordHistoryCount": "10",
    "email": "merchantuser.2020@gmail.com",
    "reEnterEmail": "merchantuser.2020@gmail.com",
    "emailMisMatchError": false,
    "password": "Vela1!"
}

Response

{
    "country": "USA",
    "addressLine1": "1234 Abc road",
    "addressLine2": "Pine Valley Street",
    "addressLine3": "",
    "city": "Port st.Lucie",
    "state": "FL",
    "zipCode": "34952",
    "id": 513,
    "userName": "Merchantuser.2020",
    "password": "$2a$11$RLeqlex62vuW9fuq5jION.2tiKYTBP075d3lxPctxEOtXxeqoPVk2",
    "status": {
        "value": "Active",
        "name": "ACTIVE"
    },
    "firstName": "Merchant",
    "lastName": "User",
    "phone": "",
    "mobile": "7777777777",
    "fax": "",
    "jobTitle": "Manager",
    "department": "Accounting",
    "roles": [{
        "id": 1324,
        "roleType": {
            "value": "Merchant User",
            "name": "MERCHANT_USER"
        },
        "checked": true
    }],
    "userChannelMap": [{
        "id": 402,
        "channel": {
            "id": 1,
            "channelName": "Sandpiper Bay Channel",
            "channelStatus": {
                "value": "Active",
                "name": "ACTIVE"
            },
            "channelType": {
                "value": "Internal",
                "name": "INTERNAL"
            },
            "createdDateTime": 1477321991000,
            "merchantId": 1,
            "lockedDateTime": null,
            "lockedByUserId": null,
            "createdUserId": 1,
            "lastModifiedUserId": 1,
            "industryType": {
                "value": "eCommerce",
                "name": "ECOMMERCE"
            },
            "allowCashAsPaymentMethodInd": true,
            "allowMoneyOrderAsPaymentMethodInd": true,
            "allowPaperCheckAsPaymentMethodInd": true,
            "paymentMethods": [{
                    "id": 242,
                    "paymentMethodType": {
                        "value": "PINless Debit Card",
                        "name": "PIN_LESS_DEBIT_CARD"
                    },
                    "paymentGateway": {
                        "value": "Chase Paymentech (Orbital)",
                        "name": "CHASE_PAYMENTECH_ORBITAL"
                    },
                    "cardBrand": {
                        "value": "VISA Debit",
                        "name": "VISA_DEBIT"
                    },
                    "cardId": 712,
                    "createdUserId": 112,
                    "lastModifiedUserId": 1,
                    "createdDateTime": 1535409349000,
                    "lastUpdatedDateTime": 1545671577000,
                    "position": 22
                },
                {
                    "id": 290,
                    "paymentMethodType": {
                        "value": "eCheck (ACH)",
                        "name": "ECHECK"
                    },
                    "paymentGateway": {
                        "value": "Chase Paymentech (Orbital)",
                        "name": "CHASE_PAYMENTECH_ORBITAL"
                    },
                    "cardBrand": {
                        "value": "eCheck (ACH)",
                        "name": "ECHECK"
                    },
                    "cardId": null,
                    "createdUserId": 1,
                    "lastModifiedUserId": 1,
                    "createdDateTime": 1536677090000,
                    "lastUpdatedDateTime": 1545671577000,
                    "position": 31
                },
                {
                    "id": 233,
                    "paymentMethodType": {
                        "value": "Credit Card",
                        "name": "CREDIT_CARD"
                    },
                    "paymentGateway": {
                        "value": "Chase Paymentech (Orbital)",
                        "name": "CHASE_PAYMENTECH_ORBITAL"
                    },
                    "cardBrand": {
                        "value": "AMERICAN EXPRESS",
                        "name": "AMEX"
                    },
                    "cardId": 703,
                    "createdUserId": 112,
                    "lastModifiedUserId": 1,
                    "createdDateTime": 1535409349000,
                    "lastUpdatedDateTime": 1545671577000,
                    "position": 13
                }
            ],
            "userCount": null,
            "assignedPaymentMethods": null,
            "message": null,
            "paymentMethodsCount": null,
            "merchantName": null
        }
    }],
    "oldEmail": "merchantuser.2020@gmail.com",
    "email": "merchantuser.2020@gmail.com",
    "locale": "en_US",
    "lastLoginDateTime": 1582047338797,
    "securityQuestionsEnrolledInd": true,
    "createdUserId": 503,
    "lastModifiedUserId": null,
    "firstLoginDateTime": null,
    "maximumAllowedLoginDays": 99999,
    "organizationName": "",
    "forceChangePasswordInd": false,
    "originalUserId": null,
    "loyaltyStatus": {
        "value": "Not Enrolled",
        "name": "NOT_ENROLLED"
    },
    "loyaltyRewardsNumber": null,
    "loyaltyEnrolledDateTime": null,
    "loyaltyTierLevel": {
        "value": "None",
        "name": "NONE"
    },
    "totalOutstandingPoints": null,
    "forgotPasswordGeneratedDateTime": null,
    "numberOfFailedLoginAttempts": 0,
    "numberOfFailedForgotPasswordAttempts": 0,
    "changePasswordDateTime": 1582047338797,
    "lockedDateTime": null,
    "lockedByUserId": null,
    "merchantId": 1,
    "createdDateTime": 1582045777000,
    "forceChangeSecurityQuestionsInd": false,
    "passwordNeverExpiresInd": false,
    "phoneCountryCallingCodeId": 1,
    "mobileCountryCallingCodeId": 1,
    "faxCountryCallingCodeId": 1,
    "customerId": null,
    "acceptTermsOfUseAgreementInd": true,
    "acceptPrivacyPolicyAgreementInd": true,
    "namePrefix": null,
    "nameSuffix": null,
    "middleInitial": "",
    "paymentAction": {
        "value": "Pre-Authorization",
        "name": "PRE_AUTHORIZATION"
    },
    "mobilePhoneCarrierType": {
        "emailDomain": "NUMBER@txt.att.net",
        "value": "AT&T",
        "countryCode": "USA",
        "name": "ATT"
    },
    "transactionCategory": {
        "value": "Card Present",
        "name": "CARD_PRESENT"
    },
    "message": {
        "code": "67",
        "type": {
            "value": "Success",
            "name": "SUCCESS"
        },
        "text": null,
        "include_i_icon": false,
        "description": "Your <strong>Password</strong> has been changed successfully. Please log in with new credentials."
    },
    "address": null,
    "fullName": null,
    "minimumPasswordLength": null,
    "minimumLowercaseAlphabets": null,
    "minimumUppercaseAlphabets": null,
    "minimumNumerics": null,
    "minimumSpecialCharacters": null,
    "sessionId": null,
    "uiType": null,
    "customerName": null,
    "customerNumber": null,
    "geoLocation": null,
    "currentPassword": null,
    "reEnterPassword": null,
    "reEnterEmail": null,
    "merchantName": null,
    "language": null,
    "merchantCode": null,
    "passwordAlreadyExists": false,
    "currentPasswordValid": false,
    "principal": null,
    "userSession": null,
    "selectedRoles": null
}

Step 2: Set Up Security Q&A

Description

The createUserSecurityQuestionAnswers endpoint is used to set up Security Questions & Answers for the user with the VELA application.

Updated As Of Version 2.6.0.0