Introduction
Introduction
Introduction
Introduction
Introduction
Introduction
Introduction
Introduction
Introduction
Introduction
Introduction
Introduction
Introduction
Introduction
Introduction
Introduction
Introduction
Introduction
Accounts
Update contact info
Money Movement
Disclosures
Banking Images
Authentication
Alerts
Banking Activity
Unlock User
Legacy Authentication
Reset Password
Experience Group
Customer Information
Transactions
E-Statement Reports
E-Statement Management
The E-Statement Management APIs enable users to access and modify statement preferences by utilizing the hostUserId. Users can choose to update statement preferences for all accounts or for a specific account only. The options available include sending the statement via email or to a physical mailing address.
To update the statement preference, the following criteria must be met:
- Multistatement is configured.
- The user needs to be active.
- For updating the statement preference across all accounts, the user level disclosure must be in the ‘ACCEPTED’ status.
- For updating the statement preference for a specific account, the account level disclosure must likewise be in the ‘ACCEPTED’ status.
E-Statement Management Use Cases:
- Retrieve statement preference for an individual account using the account ID.
Request:
curl -X 'GET' \
'https://api.candescent.com/digitalbanking/ux-users/v1/e-statements/{accountId}/disclosures?hostUserId={hostUserId}' \
-H 'authorization: Bearer 18FaavwuGejYXBhj7grtrP57ZbCX' \
-H 'correlationid: f8187c63-678f-4f0c-9263-46723794661a' \
-H 'accept: application/json' \ResponseStatus: 200 OK
{
"institutionUserDisclosures": [
{
"institutionId": "02688",
"institutionDisclosureStatus": "ACCEPTED",
"institutionUserDisclosureStatusUpdateDateTime": "1985-05-22T07:00:00.000+00:00",
"paperWaiver": false,
"accountId": "UVIWeGVI1Gj4ZSslBP2V-SbJlYaxzr6OhIXnyTYLflE",
"institutionDisclosureName": "OLS"
}
]
}- Update statement preference for an individual account using the account ID.
Request:
curl -X 'PUT' \
'https://api.candescent.com/digitalbanking/ux-users/v1/e-statements/preference?hostUserId={hostUserId}' \
-H 'authorization: Bearer 18FaavwuGejYXBhj7grtrP57ZbCX' \
-H 'correlationid: f8187c63-678f-4f0c-9263-46723794661a' \
-H 'accept: application/json' \
-H 'content-type: application/json' \
-d '{
"activateEstatement": true,
"accountId": "iXu2yyvvnxnYOViOsdCgMjCBGHIJ3zJ1kh6Ll-SVfbk"
}';ResponseStatus: 200 OK
- Update statement preferences for all accounts.
Request:
curl -X 'PUT' \
'https://api.candescent.com/digitalbanking/ux-users/v2/e-statements/user/preferences?hostUserId={hostUserId}' \
-H 'authorization: Bearer 18FaavwuGejYXBhj7grtrP57ZbCX' \
-H 'correlationid: f8187c63-678f-4f0c-9263-46723794661a' \
-H 'accept: application/json' \
-H 'content-type: application/json' \
-d '{
"activateEstatement": true
}';ResponseStatus: 204 No Content
