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

Headers

Content-Type: application/json
Authorization: Digest nonce="0cada2c21ae94896", nl="16", token="480771ff499c028178f560e395bb0d21"  

Header Attributes

ELEMENT	DESCRIPTION	FORMAT
Content-Type	Required Specifies the media type of the request body.	application/json
Authorization	Required Authentication information used to authorize the request. The Digest authorization header contains the nonce, nonce length (nl), and token.	Digest nonce="{nonce}", nl="{nonceLength}", token="{token}"
• nonce	Required Unique value used as part of the request authentication.	e.g., 0bafa2c21ae94792
• nl	Required Nonce Length. Specifies the length of the nonce value.	e.g., 19
• token	Required token is the MD5 of (Merchant Code : Secret : DATE in UTC : Nonce : Nonce Length).	MD5 hash

Request Body

{
    "notifiedUserId": 694,
    "deliveryMethod": {
        "name": "TEXT_MESSAGE_AND_EMAIL"
    },
    "notificationDeliveryPageType": {
        "name": "FORGOT_PASSWORD"
    },
    "merchantCode": "vela-atlanta"
}

Response

{
    "country": null,
    "addressLine1": null,
    "addressLine2": null,
    "addressLine3": null,
    "city": null,
    "state": null,
    "zipCode": null,
    "streetNumber": null,
    "streetName": null,
    "stateText": null,
    "countryText": null,
    "ibgeMunicipalCode": null,
    "id": null,
    "userName": null,
    "status": null,
    "firstName": null,
    "lastName": null,
    "phone": null,
    "mobile": null,
    "fax": null,
    "jobTitle": null,
    "department": null,
    "roles": [],
    "userChannelMap": [],
    "email": null,
    "locale": null,
    "firstLoginDateTime": null,
    "lastLoginDateTime": null,
    "securityQuestionsEnrolledInd": false,
    "createdUserId": null,
    "lastModifiedUserId": null,
    "lastUpdatedDateTime": null,
    "maximumAllowedLoginDays": null,
    "organizationName": null,
    "forceChangePasswordInd": false,
    "originalUserId": null,
    "loyaltyStatus": {
        "name": "NOT_ENROLLED"
    },
    "loyaltyRewardsNumber": null,
    "loyaltyEnrolledDateTime": null,
    "loyaltyTierLevel": {
        "nickname": "None",
        "name": "NONE"
    },
    "totalOutstandingLoyaltyPoints": null,
    "pendingLoyaltyPoints": null,
    "forgotPasswordGeneratedDateTime": null,
    "numberOfFailedLoginAttempts": 0,
    "numberOfFailedForgotPasswordAttempts": 0,
    "changePasswordDateTime": null,
    "lockedDateTime": null,
    "lockedByUserId": null,
    "merchantId": null,
    "createdDateTime": null,
    "forceChangeSecurityQuestionsInd": false,
    "passwordNeverExpiresInd": false,
    "phoneCountryCallingCodeId": null,
    "mobileCountryCallingCodeId": null,
    "faxCountryCallingCodeId": null,
    "acceptTermsOfUseAgreementInd": false,
    "acceptPrivacyPolicyAgreementInd": false,
    "namePrefix": null,
    "nameSuffix": null,
    "middleInitial": null,
    "paymentAction": null,
    "mobilePhoneCarrierType": {
        "emailDomain": "",
        "value": "Select",
        "countryCode": "UNKNOWN",
        "name": "UNKNOWN"
    },
    "transactionCategory": null,
    "textMessageType": null,
    "customer": null,
    "oneTimePasscode": null,
    "oneTimePasscodeCreatedDateTime": null,
    "numberOfFailedOneTimePasscodeAttempts": 0,
    "gender": null,
    "lastLockedDateTime": null,
    "lockedInterval": {
        "value": "None",
        "name": "NONE"
    },
    "currencyCode": null,
    "biometricsDeskoPentaBGRClientApplicationURL": null,
    "biometricsDeskoPenta4XCubeClientApplicationURL": null,
    "enableMultiFactorAuthentication": {
        "name": "OFF"
    },
    "message": {
        "code": "106",
        "type": {
            "name": "SUCCESS"
        },
        "include_i_icon": false,
        "description": "CHALLENGE_SECURITY_QUESTIONS_TEXT_MESSAGE_AND_EMAIL_SUCCESS",
        "parameters": null
    },
    "address": null,
    "fullName": null,
    "mobileWithCallingCode": null,
    "sessionId": null,
    "uiType": null,
    "customerId": null,
    "customerName": null,
    "customerNumber": null,
    "geolocation": null,
    "merchantName": null,
    "language": null,
    "merchantCode": null,
    "passwordAlreadyExists": false,
    "currentPasswordValid": false,
    "principal": null,
    "userSession": null,
    "selectedRoles": null,
    "numberOfInactiveLoginDays": null,
    "maskedEmail": null,
    "auditEventType": null,
    "requestAnotherOnetimePassword": false,
    "strFirstLoginDateTime": null,
    "strLastLoginDateTime": null,
    "strLoyaltyEnrolledDateTime": null,
    "unpaidInvoiceCount": null,
    "passwordExpiredInd": false,
    "passwordExpiryDaysIn": 0,
    "memberSince": null,
    "totalActivePaymentMethods": 0,
    "unpaidSalesOrderCount": 0,
    "numberOfNotifications": 0,
    "temporaryPasswordValid": false
}

Updated As Of Version 7.2.0.0