Getting Started
The E-Statement Management service supports retrieval of e-statement preferences and updating the e-statement preference for a specified financial institution (FI) customer’s account.
Before utilizing the service, ensure that the customer is registered with the financial institution and has accepted the disclosures and agreements.
The customerId of the financial institution customer must be recognized before utilizing this service because it is a required parameter for accessing the endpoints. This is the institution user’s hostUserId.
E-Statement Management
Use the Update E-Statement Preference method PUT /v1/e-statements/preference to update the statement preferences for the given customer ID and account ID.
Only one account preference can be changed at a time.
| Property Name |
Property Type |
Property Value |
Property Description |
| activateEStatement |
Boolean |
true/false |
Indicates whether e-statement should be opted in/out |
| accountId |
String |
Unique account ID |
Information needed to update the e-statement preference for a particular account |
Use Get Statement Preferences GET /v1/e-statements/user/{hostUserId}/account/{accountId}/disclosures to fetch the preference along with disclosure information for the particular account ID and host user ID.
hostUserId indicates the institution user’s Host User ID, and accountId indicates the user’s particular account ID.
The response contains the following properties:
| Property Name |
Property Value |
| institutionId |
Unique identifier of financial institution |
| institutionDisclosureStatus |
Disclosure status – whether accepted or not |
| institutionDisclosureName |
Name of the disclosure |
| paperWaiver |
If paperWaiver=true then it indicates e-statement is opted in, or else the paper statement is opted in |
| accountId |
Unique account ID of the customer |
| institutionUserDisclosureStatusUpdateDateTime |
Date/time when the disclosure status is accepted |
