Institution Preferences

Institution Alert Preferences define the default alert opt‑in and opt‑out behavior at the financial‑institution level. They allow institutions to control which alert types and delivery channels are enabled by default, establishing baseline preferences that apply to users when no user‑specific settings are configured.

End-user benefits

• Financial institutions define default alert behavior for their customer base.

Integration capabilities

• Provides centralized alert preference management at the institution level.
• Supports multi‑channel delivery (Email, SMS, Push, Web) with channel‑specific opt‑in/out controls.
• Enables flexible filtering by account, user, and alert type.

Scopes

Scope	Description
alertPref:read	Read alert preferences
alertPref:write	Write alert preferences

Required headers

Header	Description
Authorization	Bearer OAuth 2.0 access token
transactionId	UUID for request tracing

Error codes

Alert preference (PRMAPS_*)

Code	Message	HTTP Status Code
PRMAPS_10007	Invalid alert preference ID	404
PRMAPS_10008	Alert preference mismatch	400

Validation (PRMVAL_*)

Code	Message	HTTP Status Code
PRMVAL_10004	Invalid user	400
PRMVAL_10006	Invalid alert type	400
PRMVAL_10009	Requested alert type was not found for the FI	400
PRMVAL_10010	Preference not found for enrollmentId	400
PRMVAL_10011	Preference not found for institution	400
PRMVAL_10012	Value should not be null	400
PRMVAL_10013	Invalid alert preference	400
PRMVAL_10015	Alert type not configured for channel or disabled for Institution	400
PRMVAL_10016	Unsupported account type	400

Endpoints

Create Institution Alert Preference

Create user alert preference of certain user with destination presence earlier

Delete Institution Alert Preference

Removal of particular user alert preference

List Institution Alert Preferences

GET FI preference list with opt in or opt out status

Update Institution Alert Preference

Updates user alert preference for opt in/opt out