Use cases and example
The end user wants to reset their password. In this scenario, the end user is the customer of a financial institution.
- Retrieve the contact methods for the given institution customer and the customer ID type:
GET /customers/{customerId}/contact-methods?userIdType={userIdType})
- Reset the password for the given institution customer using the specified contact method:
PUT /customers/{customerId}:reset-password)
Sample Code
Here is the standard flow for resetting the password:
1 - Customer should make a Get Contact Methods request to retrieve the available destinations GET /customers/{customerId}/contact-methods?userIdType={userIdType})
Sample JSON Response:
{
"customerId": "18fc507616c646048ea400138c8ac887",
"contactMethods": [
{
"id": "123310058",
"telephoneCountryCode": "1",
"contactInfo": "1234567890",
"protocol": "SMS",
"isActivated": true,
"enrolledDateTime": "2022-03-31T00:00:00.000Z"
},
{
"id": "123310059",
"telephoneCountryCode": "1",
"contactInfo": "1234567891",
"protocol": "VOICE",
"isActivated": true,
"enrolledDateTime": "2022-03-31T00:00:00.000Z"
}]
}
2 - Based on the returned contact methods, the customer should choose the destination to which the one-time passcode should be sent.
3 - The customer should make a Reset Password request and specify the ID of the desired contact method for receiving the one-time passcode:
PUT /customers/{customerId}:reset-password
PUT /v1/e-statements/preference
Sample JSON Request
{
"contactMethodId": "123310058",
"protocol": "SMS"
}
