Electronic Statements

The E-Statement APIs let customers opt in or out of electronic vs paper statement delivery at account or user level.

Prerequisites

• MultiStatement must be configured during onboarding to true for account level update and false for user level update
• Multi-OLS disclosure agreement must be created for the account ID for account level update.
• Customer must be registered with the financial institution
• Customer must accept terms and conditions for online banking
• System must be configured with the customer's hostUserId
• Customer must have an active status

End-user benefits

• Customers can receive account statements electronically, making it faster and more convenient to view and manage statements online.
• Users can choose electronic or paper statements at either the account level or across all accounts, giving them control over how statements are delivered.
• Institutions can manage disclosure and consent requirements for electronic statements, ensuring compliance with regulatory standards and customer preferences.

Integration capabilities

• Integrate with APIs to retrieve a customer’s e‑statement opt‑in status across accounts, with support for account‑level filtering.
• Enable customers to opt in or out of electronic statements at the account or user level, supporting both per‑account and bulk preference updates.
• Integrate disclosure validation into e‑statement workflows to ensure preferences align with required institutional disclosures and consent status.
• Generate e‑statement opt‑in reports to support analytics and compliance tracking.

Scopes

Scope	Description
accounts:read	Get and find accounts
disclosures:read	Get institution disclosure context
disclosures:write	Update opt-in/out preferences
institution-users:read	Verify customer is active

Required headers

Header	Description
Authorization	Bearer token (V2 authentication)
correlationId	UUID — required on UX e-statement operations (documentation/db-apx-ux-user-services.yaml)

Error codes (UXESTMT_*)

Code	Message	HTTP Status Code
UXESTMT_10001	Required Authorization header is missing	400
UXESTMT_10002	Invalid JWT token	400
UXESTMT_10003	Required role not present in JWT token	403
UXESTMT_10004	JWT token has expired	400
UXESTMT_10005	JWT does not contain institution ID	400
UXESTMT_10006	JWT does not contain institution customer ID	400
UXESTMT_10007	Required Correlation ID header is missing / invalid	400
UXESTMT_10008	Correlation ID is not a GUID	400
UXESTMT_10011	Invalid IP address in the header	400
UXESTMT_10012	Invalid Authorization in the header	400
UXESTMT_11010	Required input fields are missing	400
UXESTMT_11012	The given account id is not available in user disclosure	400
UXESTMT_11013	User disclosure should be in ACCEPTED status	400
UXESTMT_11014	InstitutionId is invalid or incorrectly configured	400
UXESTMT_30001	InstitutionId invalid or downstream service error	500
UXESTMT_30002	Error interacting with the external service	500
UXESTMT_88888	No primary customers found / no entitled customers (operation-specific)	404
UXESTMT_88890	No primary account found	404
UXESTMT_88891	No entitled customer/account / disclosure not available for account (operation-specific)	404
UXESTMT_99998	Cannot handle this request — check URL, body and parameters	400
UXESTMT_99999	Internal server error	500

Endpoints

Fetch Disclosure Information

API to fetch disclosure information for the particular account Id

Fetch Opt-in Data

Retrieves opt-in preferences for all accounts associated with a specified customer. Supports filtering by account type.

Update Account Electronic Statement Preferences

### Before you call

Update User Electronic Statement Preferences

### Before you call