Institution Disclosures
The Institution Disclosures API manages financial‑institution disclosure definitions used to control regulatory agreements, online statements, and other disclosures presented in downstream onboarding, enrollment, and account‑servicing flows.
End-user benefits
- Retrieve the complete set of disclosure definitions (enabled and disabled) for configuration, auditing, or integration with customer‑facing experiences.
- Define and maintain disclosures that determine what content is presented to users, such as regulatory agreements or online statement disclosures.
Integration capabilities
- Get all disclosures configured for the institution making the request.
- Create a new disclosure by name, with optional URL-based content, and set whether it is enabled or disabled.
- Update an existing disclosure’s name, content, or enabled status. The disclosure ID in the request path and body must match.
Scopes
| Scope | Description |
|---|---|
disclosures:read | Retrieve disclosure information |
disclosures:write | Create, update, or delete disclosures |
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 Institution Disclosures
Retrieves all institution disclosure definitions configured for the financial institution
Create Institution Disclosure
This endpoint is part of the Disclosures Service, which manages disclosure definitions for
Update Institution Disclosure
Updates an existing institution disclosure definition for the financial institution