Retrieve E-Statement Account Preferences
Loading...
API endpoint path: /v1/e-statements/{accountId}/disclosures
Returns electronic statement disclosure data for the authenticated user's specified account (including current disclosure status and statement delivery preference).
Use this endpoint to:
- View electronic statement/Online Statement disclosure (OLS) details for a single account (including status, paper‑waiver preference, disclosure name, and last update time).
- Determine whether electronic or paper statements are currently recorded for the account before invoking the account preference update API.
- Display or audit disclosure status information associated with the selected account.
Prerequisites:
- Multi‑statement support (multiple account online statement preference selection) must be enabled for the institution.
Behaviors and capabilities:
- Results are filtered only by the 'accountId' provided in the path, and disclosures without an 'accountId' or statement preference are excluded.
- If no disclosures meet the criteria, the service returns 200 with an empty
institutionUserDisclosuresarray.
Request
Responses
- 200
- 400
- 403
- 404
- 500
- 503
Success
Bad Request
Forbidden
Not Found
Internal Server Error
Service Unavailable
Was this page helpful?