Introduction
The E-Statement APIs manages the delivery preferences for statements by interacting with Users, Accounts, and Disclosures services for a given customer of a specified financial institution. The available options consist of sending the statement through email or to a physical mailing address.
Before utilizing the E-Statement APIs, the following requirements must be fulfilled:
- MultiStatement for Online Statement is configured.
- The customer is required to accept the terms and conditions related to enrolling in online banking and opt-in for online statements.
- The status of the customer must be active.
What is supported?
The E-Statement APIs provide the following features:
- View the statement preference associated with a specific account.
- Update statement delivery preference for an individual account.
- Update statement delivery preference for all accounts.
- Support RETAIL and PRIMARY institution user types.
Required Roles & Permissions
To access the E-Statement APIs, the following scopes must be obtained: