E-Statement Management
E-Statement Management helps to enroll or unenroll e-statements by account ID and hostUserId.
The basic criteria to enroll or unenroll e-statements for an account include a disclosure status set to
ACCEPTED and the user having an active status.
E-Statement Management Use Cases Documentation:
-
API to update the statement preferences:
PUT /v1/e-statements/preferences?hostUserId={hostUserId}
The API can be used to update the preferences of the account statement delivery to either deliver
the statement by email or to send it to a postal address.
-
API to fetch disclosure information for the particular account ID:
GET /v1/e-statements/{accountId}/disclosures?hostUserId={hostUserId}
This is the API to fetch disclosure information for the particular account.
Example Code
Request: API to fetch disclosure information for the particular account ID:
GET /v1/e-statements/{accountId}/disclosures?hostUserId={hostUserId}
Response Status: 200 OK
Sample JSON Response:
{
"institutionUserDisclosures": [
{
"institutionId": "02688",
"institutionDisclosureStatus": "ACCEPTED",
"institutionUserDisclosureStatusUpdateDateTime": "1985-05-22T07:00:00.000+00:00",
"paperWaiver": false,
"accountId": "UVIWeGVI1Gj4ZSslBP2V-SbJlYaxzr6OhIXnyTYLflE",
"institutionDisclosureName": "OLS"
}
]
}
Request: API to update the preferences of the statement delivery
PUT /v1/e-statements/preference
Sample JSON Request
{
"activateEstatement": true,
"accountId": "UVIWeGVI1Gj4ZSslBP2V-SbJlYaxzr6OhIXnyTYLflE"
}
