Forgot Password - Pick Your Delivery Method

After the user answers the security questions via Challenge Security Questions, the user is asked to choose the delivery method to send the temporary password either via email or mobile number or both.

Description

The sendNotification endpoint is used to send a temporary password to the user.

Request

Endpoint

ui/v1/sendNotification   

Method

POST

Header

Content-Type: application/json  

Request Body

{
    "userId": 514,
    "deliveryMethod": {
        "name": "TEXT_MESSAGE_AND_EMAIL"
    },
    "screenName": "forgotPassword"
}

Response

{
    "country": "USA",
    "addressLine1": "4500 SE",
    "addressLine2": "Pine Valley Street",
    "addressLine3": "",
    "city": "Port st.Lucie",
    "state": "FL",
    "zipCode": "34952",
    "id": 514,
    "userName": "New.user",
    "password": "$2a$11$eeTcZmP9b9Wg8o34Ir1PhuNKHhHP8IsQsi4giNZjJ5cBuv0HweiJS",
    "status": {
        "value": "Active",
        "name": "ACTIVE"
    },
    "firstName": "New",
    "lastName": "User",
    "phone": "",
    "mobile": "2344322344",
    "fax": "",
    "jobTitle": "Manager",
    "department": "Accounting",
    "roles": [{
        "id": 1325,
        "roleType": {
            "value": "Merchant Admin",
            "name": "MERCHANT_ADMIN"
        },
        "checked": true
    }],
    "userChannelMap": [{
        "id": 403,
        "channel": {
            "id": 1,
            "channelName": "VELA 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": "new.user@gmail.com",
    "email": "new.user@gmail.com",
    "locale": "en_US",
    "lastLoginDateTime": null,
    "securityQuestionsEnrolledInd": true,
    "createdUserId": 340,
    "lastModifiedUserId": 514,
    "firstLoginDateTime": 1582315194000,
    "maximumAllowedLoginDays": 99999,
    "organizationName": "Vela",
    "forceChangePasswordInd": true,
    "originalUserId": null,
    "loyaltyStatus": {
        "value": "Not Enrolled",
        "name": "NOT_ENROLLED"
    },
    "loyaltyRewardsNumber": null,
    "loyaltyEnrolledDateTime": null,
    "loyaltyTierLevel": {
        "value": "None",
        "name": "NONE"
    },
    "totalOutstandingPoints": null,
    "forgotPasswordGeneratedDateTime": 1582814549061,
    "numberOfFailedLoginAttempts": 0,
    "numberOfFailedForgotPasswordAttempts": 0,
    "changePasswordDateTime": 1582814496000,
    "lockedDateTime": null,
    "lockedByUserId": null,
    "merchantId": 1,
    "createdDateTime": 1582315120000,
    "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@sms.cellonenation.net",
        "value": "Cellular One",
        "countryCode": "USA",
        "name": "CELLULAR_ONE"
    },
    "transactionCategory": {
        "value": "Card Not Present",
        "name": "CARD_NOT_PRESENT"
    },
    "message": {
        "code": "106",
        "type": {
            "value": "Success",
            "name": "SUCCESS"
        },
        "text": null,
        "include_i_icon": false,
        "description": "If the information provided was correct, you will receive an <strong>email</strong> and a <strong>text message</strong> shortly with your temporary password. Message and Data rates may apply for text messages."
    },
    "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
}  

Updated As Of Version 2.4.0.0