Introduction
Introduction
Introduction
Introduction
Introduction
Introduction
Introduction
Introduction
Introduction
Introduction
Introduction
Introduction
Introduction
Introduction
Introduction
Introduction
Introduction
Introduction
Accounts
Update contact info
Money Movement
Disclosures
Banking Images
Authentication
Alerts
Banking Activity
Unlock User
Legacy Authentication
Reset Password
Experience Group
Customer Information
Transactions
E-Statement Reports
Getting Started
The E-Statement Management service allows customers to manage how they receive their financial statements—online or by mail—across individual or multiple accounts.
What it does
This service provides customers with the ability to:
- View current statement preferences for any account.
- Update delivery method (e.g., switch from paper to digital) for a single account.
- Apply a unified preference across all accounts with one action.
- Track disclosure status to ensure compliance before activating digital delivery.
When to Use It
- During account setup or onboarding, to choose preferred statement delivery.
- When a customer wants to go paperless for convenience or sustainability.
- To review or change preferences after a life event or account update.
- When disclosures need to be accepted or reviewed before enabling digital statements.
- To align preferences across multiple accounts for consistency.
Requirements
- The customer must be registered with the financial institution.
- The customer must have accepted all required disclosure agreements.
- The system must be configured with the customer’s hostUserId, which uniquely identifies the customer within the financial institution’s ecosystem. The hostUserId is a required parameter for all API interactions and must be linked to the customer’s profile in the system.
- The customer must have an active status.
E-Statement Management
- Retrieve statement preference for an individual account using the account ID.
GET /v1/e-statements/{accountId}/disclosures?hostUserId={hostUserId}
hostUserIdindicates the institution customer’s host Id.accountIdindicates the customer’s account Id.
Response Body :
- Update statement preference for an individual account using the account ID.
PUT /v1/e-statements/preference?hostUserId={hostUserId}
hostUserIdindicates the institution customer’s host Id.
Response Body :
- Update statement preferences for all accounts.
PUT /v2/e-statements/user/preferences?hostUserId={hostUserId}
hostUserId indicates the institution customer’s host Id.
Response Body :
