Electronic Statements

The Electronic Statements APIs enable customers to opt in or out of electronic or paper statement delivery at either the account or user level.

Prerequisites

• MultiStatement (multiple account online statement preference selection) must be enabled (true) to support account‑level retrieval and updates.
• Customers must accept the electronic statement disclosure agreement at the user level. If not already accepted, see the Create User Disclosure API to create it.
• Customers must have an active status.

End-user benefits

• Access statements electronically for a faster and more convenient experience when viewing and managing accounts online.
• Flexibility to choose electronic or paper delivery at the account level or across all accounts.
• Assurance that disclosure and consent requirements are properly managed, supporting both compliance and customer preferences.

Integration capabilities

• Retrieve a customer’s e‑statement opt‑in status across accounts, with support for account‑level filtering.
• Enable customers to opt in or out at the account or user level, including both individual and bulk updates.
• Incorporate disclosure validation into workflows to ensure preferences align with required consent and institutional policies.
• Generate e‑statement opt‑in reports for analytics, monitoring, 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	Unique identifier for request tracking

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 token is invalid, does not contain institution id	400
UXESTMT_10006	JWT token is invalid, does not contain institution customers id	400
UXESTMT_10007	Required Correlation Id header is missing	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_11007	Invalid path param	400
UXESTMT_11008	Invalid path	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 its incorrectly configured	400
UXESTMT_11015	The days difference should not be greater than 90 days	400
UXESTMT_11016	From date can not be greater than to date	400
UXESTMT_11017	Invalid date format, the date format should be dd-MM-yyyy	400
UXESTMT_11018	Invalid request, please check the input parameters	400
UXESTMT_11019	fromDate and toDate can not be same	400
UXESTMT_11020	No accounts are available in user disclosure to update	400
UXESTMT_11021	Multi-statement functionality is not set up for this institution.	400
UXESTMT_30001	Error interacting with the service	500 or 503
UXESTMT_30002	Error interacting with the external service	500 or 503
UXESTMT_30003	Disclosure not available	503
UXESTMT_88888	No entitled customers found	404
UXESTMT_88889	The given user is not active	400
UXESTMT_88891	Disclosures name is not available for the given account id	404
UXESTMT_99998	Cannot handle this request. Please check the url, request body and parameters	400, 500, or 503

Endpoints

Fetch Opt-in Data

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

Fetch Disclosure Information

API to fetch disclosure information for the particular account Id

Update User Electronic Statement Preferences

### Before you call

Update Account Electronic Statement Preferences

### Before you call