Usage Tutorial

The Reset Password service supports the retrieval of contact methods defined for a specified financial institution (FI) customer and the sending of a one-time passcode to the designated contact method for resetting a customer's password. Before utilizing this service, ensure that the customer is registered with the financial institution and has accepted the disclosures and agreements.

The customerId of the financial institution customer must be recognized before utilizing the Reset Password service because it is a required parameter for accessing the endpoints. This is the institution user's institutionCustomerId .

Customer Contact Methods

Use the Get Contact Methods endpoint GET /customers/{customerId}/contact-methods?userIdType={userIdType}) to retrieve the contact methods available for a specified financial institution customer and customer ID type.

The allowable userIdType query parameter values are CUSTOMER_ID, LOGIN_ID.

userIdType query parameter values	Get endpoint	Definition
CUSTOMER_ID	/customers/{customerId}/contact-methods?userIdType=CUSTOMER_ID	This is the FI Customer Id.
LOGIN_ID	/customers/{loginId}/contact-methods?userIdType=LOGIN_ID	This is the "loginId" of FI Customer - same as the username for logging in to the online application.

The response contains customer ID and contact methods.

Property Name	Property Value
customerId	Unique identifier of financial institution customer
Each contact method contains the following fields:
id	Unique identifier of this contact method. When consuming the Reset Password endpoint, this is the ID that should be used for the destination if the one-time passcode should be sent via this contact method.
telephoneCountryCode	Country code of phone number, applicable only if this contact method is a phone number.
contactInfo	If this contact method is a phone number, the value of this property is the phone number.
protocol	Signifies how notifications get sent to this destination. 1. SMS - The contactInfo value is a phone number, and the notification will be sent as a text message. 2. VOICE - The contactInfo value is a phone number, and the notification will be sent as a voice call.
isActivated	This is true if this contact method has been activated and is available for receiving notifications; false otherwise.
enrolledDateTime	Date and time when this contact method was enrolled with the customer.

Reset Password

After identifying the contact method to use for sending the one-time passcode, use the Reset Password endpoint (PUT /customers/{customerId}:reset-password) for sending the notification to the specified destination. Once the end user receives the one-time passcode, they can use it for logging into the online application and reset their password.