Update User Electronic Statement Preferences

Loading...

API endpoint path: /ux-users/v2/e-statements/user/preferences

Before you call

• MultiStatement — This API is available only when the MultiStatement feature configured to false for the financial institution during the onboarding process.
• Disclosure — The preference applies only where the applicable e-statement disclosure has been approved for the user.
• Access token — Obtain a V2 OAuth 2.0 access token by calling POST /oauth2/v1/token (Authentication API — Create V2 access token). Grant types, required headers (for example institutionId, transactionid), and form body are defined in that operation. Then pass the token in the Authorization header as Bearer <access_token>. For full details, see the Authentication API reference.

Behavior

Enables users to apply a unified statement delivery preference (online or mail) to all of their accounts.

Request

Responses

204

Preference applied to all accounts successfully. No content returned.

400

The request is malformed or contains invalid parameters. Check the accountId, hostUserId, or other query inputs for correctness.

401

Authentication failed. The request lacks valid credentials or the OAuth 2.0 Bearer token is missing or invalid.

403

The authenticated user does not have permission to access the requested resource.

404

The requested user or account ID cannot be found within the system.

500

An unexpected error occurred on the server. Please try again later or contact support if the issue persists.