Skip to main content

User Disclosures

Institution User Disclosure APIs manage user‑level disclosure acceptance and enrollment. They track whether individual users have accepted, rejected, or enrolled in required disclosures—supporting compliance during onboarding, account updates, and ongoing digital banking usage.

End-user benefits

  • View and accept required disclosures during onboarding.
  • Query current disclosure and enrollment status.

Integration capabilities

  • Track end-user acceptance programmatically.
  • Align with e-statement enrollment.
  • Business Banking: use institutionCustomerId for location/business context; resolve the business entity via the Institution User API when needed.

User disclosure statuses

StatusDescription
ENROLLEDUser enrolled (e.g. e-statements)
NOT_ENROLLEDNot enrolled
ACCEPTEDDisclosure accepted
NOT_ACCEPTEDDisclosure not accepted

Scopes

ScopeDescription
accounts:readGet and find accounts
disclosures:readRetrieve disclosure information
disclosures:writeCreate, update, or delete disclosures
institution-users:readRequired with disclosures:read for user context

Required headers

HeaderDescription
AuthorizationBearer token (V2 authentication)
transactionIdUnique identifier for request tracking

Error codes (DSC_*)

CodeMessageHTTP Status Code
DSC_10002Invalid request400
DSC_10003Invalid operation501
DSC_10009Invalid query param400
DSC_11001Full authentication was not provided in the request401
DSC_11002The authentication token is invalid401
DSC_11003The authentication does not authorize this request401
DSC_11004A location id is required for business banking users400
DSC_12001Request should only contain printable ASCII characters400
DSC_12002Request is missing a transactionId header400
DSC_12003Request transactionId header is too long400
DSC_12004Required fields are not provided or not valid400
DSC_12005Request cannot be blank400
DSC_12006Invalid or empty account type in request400
DSC_12007Request header is too long400
DSC_12011One of the request field lengths is greater than max length400
DSC_12012Disclosure ids from request body and URL do not match400
DSC_12013Request callingAppId header is too long400
DSC_13001Data not found for user400
DSC_13002Disclosures are not retrieved successfully500
DSC_13003Disclosures are not created successfully500
DSC_13004Disclosures are not updated successfully500
DSC_22001Internal validation error500
DSC_23002Error interacting with CBS Service500
DSC_23003Error interacting with CAS Service500
DSC_90000Server cannot handle this request400
DSC_99997Client error400
DSC_99999Internal server error500

Endpoints