Skip to main content

List User Disclosures

Loading...
API endpoint path: /db-disclosures/v1/institution-user-disclosures

Retrieves a consolidated list of user disclosure records for the authenticated user. The response represents the authoritative view of the user’s acceptance or enrollment state for institution disclosures.

Use this endpoint to:

  • Retrieve all disclosure statuses associated with an institution user.
  • Display user‑level and account‑level disclosure acceptance for features such as online statements.
  • Support user experience flows that require visibility into disclosure enrollment or acceptance history.
  • Audit or reconcile user disclosure records across disclosure types.

Behavior and capabilities:

  • Aggregates disclosure data from multiple backend sources and normalizes all sources into a single InstitutionUserDisclosure structure, including disclosure identifiers or names, status, status update timestamps, and optional paperWaiver and accountId for account‑scoped disclosures.
  • Supports both retail and Business Banking users; Business Banking requests require a valid institutionCustomerId, while retail requests derive customer context from the access token.
  • A successful response returns HTTP 200 with either a populated or empty institutionUserDisclosures collection.

Request

Responses

Success