.png)
Introduction
The E-Statement API features a set of services used to opt in for e-statement or paper statement preferences for a customer's account at a specified financial institution. A customer's current preferences can also be retrieved to verify the same.
An example of such a disclosure is the request for a customer’s acceptance of Terms or Conditions when enrolling for Online Banking. Another would be signing up for electronic banking statements.
The E-Statement API enables customers to:
- opt in and opt out of e-statement preference
- ensure the desired preference is activated
What is supported?
The Disclosures API enables Customers to:
- E-statement opt-in/out feature for an account level is supported.
- View e-statement opt-in status for a given user account.
- Supported institution user types are RETAIL and PRIMARY.
- Multi-OLS disclosure should be created for the account ID for the APIs to work.
The E-Statement API interfaces with Users API, Disclosures API, and Accounts API.
Required Roles & Permissions
In order to access the E-Statement API, the following scopes are needed:
accounts:read - A user with this role may get and find Accounts API.
disclosures:read - A user with this role may get and find institution Disclosure Service.
disclosures:write - A user with this role to update opt-in/out
institution-users:read - A user with this scope may check if the customer is active or not.
