.png)
Product Overview
The Update Contact Info API features a set of basic services used to update the contact information of a customer at a specified financial institution (FI). A customer’s contact info details will be modified or updated, and the desired contact info can be used for logging into the customer’s account.
Value
The Update Contact Info API enables customers to:
- Quickly modify/update the user contact information.
- The user will be able to use the updated contact information as credentials for login purposes.
- By having up-to-date contact information, phone numbers can be used for OTP / MFA.
It enables developers to:
- Quickly validate the existing customer’s contact information.
- Provide the customer a quick method to update the contact information.
What is Supported
The Update Contact Info service supports the following uses:
- Verifying that a customer exists at a specified financial institution
- The endpoint allows customer to update either the email address or phone number and postal address at one time.
- The customer will be notified which contact information has been updated.
- The updated information can directly be used by customer for logging into the online application.
Additional Product Details
The Update Contact Info API interfaces with and depends on the Users API.
Roles and Requirements
Required Roles & Permissions
In order for a partner to access the Update Contact API, you will need a user with one of the following scopes:
| Scope | Permissions |
|---|---|
| institution-users:write | A user with this scope may update/modify the contact information of the specified financial institution customer. |
System Requirements & Configurations
The Update Contact Info 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.
