User Disclosures

The User Disclosures API tracks user‑level and account‑level disclosure acceptance and enrollment for institution disclosures. It supports custom disclosures, online statements (OLS), and related flows such as e‑sign (ESIGN) and Internet Banking (IB).

This API is typically used during onboarding, account servicing, and preference‑management experiences to determine whether required disclosures have been accepted or whether users are enrolled in optional services such as online statements.

End-user benefits

• View acceptance or enrollment status for required disclosures during onboarding or account updates.
• Manage online statement preferences at the account level, including paperless settings.

Integration capabilities

• Get the current disclosure acceptance and enrollment status for a user, including any account‑level settings.
• Capture user acceptance of disclosures or enrollment in online statements.
• Update the status of custom disclosures.
• Unenroll an account from online statements.
• When using client credentials authentication, provide either hostUserId or loginId (mutually exclusive).
• Use institutionCustomerId to scope results to a specific business location (see the Get Customer Profile API for more details). This is specific to Business Banking users.

Scopes

Scope	Description
accounts:read	Get and find accounts
disclosures:read	Retrieve disclosure information
disclosures:write	Create, update, or delete disclosures
institution-users:read	Required with disclosures:read for user context

Required headers

Header	Description
Authorization	Bearer {token} (OAuth V2)
transactionId	UUID used to trace and correlate requests across services for debugging and logging.

Error codes (DSC_*)

Code	Message	HTTP Status Code
DSC_10002	Invalid request.	400
DSC_10003	Invalid operation.	501
DSC_10009	Invalid query param.	400
DSC_11001	Full authentication was not provided in the request.	401
DSC_11002	The authentication token that was sent in the request is invalid.	401
DSC_11003	The authentication provided does not authorize this request.	401
DSC_11004	A location id is required for business banking users	400
DSC_12001	Request should only contain printable ASCII characters.	400
DSC_12002	Request is missing a transactionId header.	400
DSC_12003	Request transactionId header is too long.	400
DSC_12004	Required fields are not provided or not valid.	400
DSC_12005	Request cannot be blank.	400
DSC_12006	Invalid or empty account type in request.	400
DSC_12007	Request header is too long	400
DSC_12011	One of the request field length is greater than max length.	400
DSC_12012	Disclosure ids from request body and URL do not match.	400
DSC_12013	Request callingAppId header is too long.	400
DSC_12014	RequestBody size exceeds limit.	400
DSC_12015	Disclosure not supported	400
DSC_12016	Account Id is missing in disclosure	400
DSC_12017	Paper waiver field is missing in disclosure	400
DSC_13001	Data not found for user	400
DSC_13002	Disclosures are not retrieved successfully.	500
DSC_13003	Disclosures are not created successfully.	500
DSC_13004	Disclosures are not updated successfully.	500
DSC_13005	The CIF number is required, but was not found	400
DSC_22001	Internal validation error.	500
DSC_23002	Error interacting with CBS Service	500
DSC_23003	Error interacting with CAS Service	500
DSC_23004	Error interacting with NIIS Service	500
DSC_23005	Error interacting with Accounts Service	500
DSC_90000	Server cannot handle this request.	400
DSC_99997	Client error	400
DSC_99999	Internal server error.	500

Endpoints

List User Disclosures

Retrieves a consolidated list of user disclosure records for the authenticated user. The

Create User Disclosure

Creates or persists a user‑level disclosure record for the authenticated user within the

Update Custom User Disclosure

Updates the acceptance or enrollment state of a **custom user disclosure** for the

Delete Online Statement User Disclosure

Deletes the user’s online statement (OLS) disclosure enrollment for a specific account by