Introduction
Accounts
Update contact info
Money Movement
Disclosures
Banking Images
Authentication
Alerts
Banking Activity
Unlock User
Legacy Authentication
Reset Password
Experience Group
Customer Information
Transactions
E-Statement Reports
.png)
Send a one-time passcode to a given customer for resetting their password
ENDPOINTS
put
/v1/customers/{customerId}:reset-password
Header parameters
Collapse
correlationId
string
required
UUID that uniquely identifies the request. This id allows the request to be traced through the entire request and response flow.
Authorization
string
required
Standard OAuth 2.0 access token. A string composed of 'Bearer' + '(space)' + '{token}'
Body parameters
Collapse
{"contactMethodId":"123310058","protocol":"SMS"}
Path parameters
Collapse
customerId
string
required
Unique identifier of financial institution customer
Responses
Collapse
204
Request to reset password sent successfully
Response Body
null
400
Bad Request
Response Body
{"status":0,"message":"string","code":"string"}
401
Unauthorized
Response Body
{"status":0,"message":"string","code":"string"}
403
Forbidden
Response Body
{"status":0,"message":"string","code":"string"}
404
User not found
Response Body
{"status":0,"message":"string","code":"string"}
500
Server error
Response Body
{"status":0,"message":"string","code":"string"}
CURL REQUEST
curl --request PUT \
--url https://api.candescent.com/digitalbanking/ux-users/v1/customers/{customerId}:reset-password \
--header 'Authorization: SOME_STRING_VALUE' \
--header 'accept: application/json' \
--header 'content-type: application/json' \
--header 'correlationId: SOME_STRING_VALUE' \
--data '{"contactMethodId":"123310058","protocol":"SMS"}'RESPONSE
