.png)
Product Overview
The Unlock User API features a set of basic services used to unlock a user for the specified financial institution (FI). A user account becomes locked after the user has exceeded the allowed number of failed login attempts. This API allows a customer to unlock a user without requiring a password reset.
Value
The Unlock User API enables customers to:
- Ensure the user account is in a locked status
- Unlock the user without requiring a password reset
It enables developers to:
- Quickly validate the existing customer’s user status
- Provide the customer a quick method to directly unlock the user account
What is Supported
The Unlock User service supports the following uses:
- Verifying that a customer is locked at a specified financial institution
- Unlocking the user directly without requiring a password reset
Additional Product Details
The Unlock User API interfaces with and depends on the Users API.
Roles and Requirements
Required Roles & Permissions
In order for a partner to access the Unlock User API, you will need a user with one of the following scopes:
| Scope | Permissions |
|---|---|
| institution-users:write | A user with this scope may trigger the unlocking of the specified financial institution customer. |
System Requirements & Configurations
The Unlock User service must be accessed through a gateway managed by the Candescent Enterprise Platform team. It uses a v2 authentication token and requires the token to be generated.
