Skip to main content

Retrieve E‑Statement Accounts Opt‑In Report

Loading...
API endpoint path: /v1/reports/e-statements

Generates an e‑statement opt‑in report by combining institution users, their accepted electronic statement disclosures, and related account details. Each report record represents a single account and includes user information, account number and type, statement delivery preference (electronic or paper), and the disclosure status update timestamp. The report can be generated for a single customer with optional filtering by account type.

Use this endpoint to:

  • Generate opt‑in and statement delivery reports for compliance, operations, or customer support.
  • Retrieve report data for a single customer using 'customerId'.
  • Limit results to a specific account type such as checking or savings.

Prerequisites:

  • Multi‑statement support (multiple account online statement preference selection) must be enabled for the institution.

Behaviors and capabilities:

  • When 'customerId' is provided, the report is generated for a single customer.
  • When 'accountType' is specified, only report with a matching account type (case‑insensitive) are included, and 'totalCount' reflects the number of records returned after filtering.
  • The service returns 200 on success, may return 206 Partial Content when some downstream data cannot be retrieved, and returns 404 when no qualifying data is found.

Request​

Responses​

Success