Details

openapi: 3.0.0 info: version: '0.0' title: Institution Details description: >- Provides configuration settings at both the institution and user levels. When you have a user session, you must use the user settings in preference to the institution settings. (All relevant institution settings are provided along with the user settings, so you need only a single API call.) Some settings can only be configured at the institution level, while others can further be configured at the user level. contact: name: Banno servers: - url: 'https://{API_ENVIRONMENT}/a/consumer/api/v0' variables: API_ENVIRONMENT: default: digital.garden-fi.com description: FI specific hostname tags: - name: Institution Details description: Retrieve the settings for an institution - name: User-Specific Institution Abilities description: Retrieve the institution settings as specialized for a specific user - name: User Details description: User-Specific overrides and settings paths: "/institutions/{institutionId}": get: operationId: fetchInstitutionAbilities tags: - Institution Details description: >- Returns general information about an institutions's configuration. This includes current abilities, account types, etc. If you do not need all of this data you can get better caching semantics and likely better performance by requesting only the information you need from other more targeted endpoints, if such endpoints exist. parameters: - in: path name: institutionId description: ID of the desired institution required: true schema: type: string format: uuid example: 00000000-0000-0000-0000-000000000000 responses: "200": description: OK content: application/json: schema: $ref: "#/components/schemas/institutionDetails" "404": description: Not Found "500": description: Internal Server Error '/users/{userId}/institutions/{institutionId}': get: deprecated: true operationId: fetchUserAbilities tags: - User-Specific Institution Abilities description: | Requires authentication and provides much the same response as the get institution abilities, but provides overrides for a specific user. Used to enable or disable features on a per-user basis. Clients must use the client-specific abilities over the institution defaults. This endpoint will indicate whether the user is a Net Teller cash management user. This endpoint does not support being used with an Access Token from the Admin API security: - OpenID_Connect: - 'https://api.banno.com/consumer/auth/user.profile.readonly' parameters: - in: path name: userId description: ID of a User required: true schema: type: string - in: path name: institutionId required: true description: ID of an institution schema: type: string responses: '200': description: >- This will return the same JSON as Institution Details, but the `links` field will be correctly populated for that user's permissions. content: application/json: schema: $ref: '#/components/schemas/institutionDetails' '400': description: Bad Request '401': description: Unauthorized '403': description: Forbidden '404': description: User not found '/isCashManagement': get: operationId: fetchUserIsCashManagement tags: - User Details security: - OpenID_Connect: - 'https://api.banno.com/consumer/auth/user.profile.readonly' responses: '200': description: Is the user a Cash Management user. content: application/json: schema: type: object required: - isCashManagement properties: isCashManagement: type: boolean description: Is the user a Cash Management user. '400': description: Bad Request '401': description: Unauthorized '403': description: Forbidden "/institutions/{institutionId}/app": get: operationId: fetchInstitutionAppInfo tags: - Institution Details description: Provides information to the apps to alert them to changes that are necessary parameters: - in: path name: institutionId description: ID of the desired institution required: true schema: type: string responses: "200": description: OK content: application/json: schema: $ref: "#/components/schemas/institutionAppInfo" "/institutions/{institutionId}/themes": get: operationId: fetchInstitutionThemes tags: - Institution Details description: Provides all theme information for the given institution. parameters: - in: path name: institutionId description: ID of the desired institution required: true schema: type: string responses: "200": description: OK content: application/json: schema: $ref: "#/components/schemas/institutionThemes" components: securitySchemes: OpenID_Connect: type: openIdConnect description: OpenID Connect - Discovery endpoint will be institution specific openIdConnectUrl: >- https://digital.garden-fi.com/a/consumer/api/v0/oidc/.well-known/openid-configuration schemas: institutionDetails: type: object required: - id - name - supportEmail - url - status - abilities - availableTransferFrequencies - externalTransferSettings - cutOffTimeMessage - balanceDisplaySettings - cardManagementAbilities - accountTypes - eula - displayStrings - theme - links - staticLinks - smallBusinessSettings - stopPaymentsSettings - regDSettings - transferMemos - travelNoticeCharLimit properties: id: type: string description: >- UUID ID of the institution. This will always be the same path variable used to lookup the user or institution level details. This makes this data redundant, which is why the field is deprecated. format: uuid deprecated: true example: 00000000-0000-0000-0000-000000000000 name: type: string description: Name of the institution phoneNumber: type: string description: Phone number of the institution contactHtml: type: string description: Contact HTML supportEmail: type: string description: Support email address for the institution format: email contactEmail: type: string description: Contact email address for the institution format: email welcomeHtml: type: string description: Welcome HTML privacyPolicyUrl: type: string description: Public URL to the institution's privacy policy. May be `null` if it hasn't been set yet for the given institution. url: type: string description: URL to the institution's website format: uri status: type: string enum: - Fake - Unsupported - Pre Release - Live - Non Subscriber - Implementation - Onboarding - Verifying Onboarding - Acceptance Testing - Accepted description: Describes the current state of the institution in Banno's system aggregationType: type: string enum: - Online Banking - Core - NetTeller - SymXchange description: Describes where Banno gets data like balances and transactions for users transferFee: type: string description: This will be null if we do not send a fee. If there is a fee returned, it might also include 0.00 if we submit a zero dollar fee to the transfer. billPayFee: type: string description: This will be null if we do not send a fee. If there is a fee returned, it might also include 0.00 if we submit a zero dollar fee to the transfer. billPayP2PFee: type: string description: This will be null if we do not send a fee. If there is a fee returned, it might also include 0.00 if we submit a zero dollar fee to the transfer. accountNameCharLimit: type: integer description: >- Character limit for account name editing This value is derived from the `aggregationType`. The value is `20` if the institution has an `aggregationType` equal to `Netteller`, `16` if the institution has an `aggregationType` equal to `Symxchange`, and `null` otherwise. travelNoticeCharLimit: type: integer deprecated: true description: >- This is the maximum number of characters that a cards travel notice may be. This value is always 47, which is why it is deprecated. It is not expected to ever change. minimumVersions: deprecated: true description: This information should be retrieved from `/a/consumer/api/v0/institutions/{institutionId}/app` instead. type: object properties: android: type: integer example: 315 description: The minimum version code that the Android application must be to correctly and securely communicate with the API iOS: type: string example: 2.2.0 description: The minimum version that the iOS application must be to correctly and securely communicate with the API abilities: type: object required: - accountToAccount - account_jx_meta - account_pscu_meta - account_rewards - account_symx_meta - ach - achApprovalsRequireInitiate - achBatchDownload - achDisplayBulkInitiate - achDisplayResetRecords - achDisplayResetRecordsWhenCopyingBatch - adsEnabled - advancedCardControls - alertsEnabled - allowInternationalUsdWires - allowSSNSignup - alternateAccountTransferFlow - approveUsers - billPayEnrollment - billPaySync - billpay - businessRdc - canEditMFAQuestions - cardHubMobileSDK - cardsActivate - cardsLost - cardsReorder - cardsStolen - cashManagementReports - changeAccountName - changeAddress - changeEmail - changeOrganizationEmail - changeOrganizationPhone - changePhone - changeUisEmail - changeUisPhone - changeUsername - checkImagesEnabled - conversations - coreOfflineSupport - creditCardControls - creditCardPayments - displayCutoffTimes - distinctBusinessProfiles - documentAbilities - documents - ediTransactionDetails - enableAchHolds - enableAchPrenotes - enableAchRecurringBatches - enableAchTaxPayments - enableCopyBatch - enableCopyHistoricalBatch - enforceBSLEntitlements - exportTransactionsEnabled - externalAccounts - externalTransferInbound - externalTransferOutbound - fullServiceCreditCardPayments - geezeoInsights - geezeoTrx - geezeoWheel - memberToMemberTransfers - merchantAcquisition - mobileAdsEnabled - moovPullFromCard - moovPushToCard - p2pEnabled - passwordManagement - payAnIndividualBillPay - payReturnAllExceptions - payeeCreation - payeeDeletion - payeeEdit - payeeEditP2PSMS - paymentCardManagement - positivePay - pospayExceptionCorrection - rdc - rdcOnboardingByAccountsEnabled - rdcOnboardingEnabled - recurringTransactions - requiresUserProfile - runningBalance - schedulableTransfers - screenShare - selfEnrollment - selfRecovery - selfServiceForms - separateBillPayAccounts - sessionExpirationTimeoutMinutes - sessionResumptionMethod - spendingBreakdown - stopPayments - switchUserEnabled - thirdPartyAccounts - travelNotices - twoFAEnabled - twoFAPhoneValidation - userManagement - videoChat - warningCodes - wires - wiresInitiateWithJHW - zelle properties: clientSideRDCProvider: type: string description: Returns the available client-side RDC provider, if any. If none is available, then `null` will be returned. RDC provider is configured FI-wide, not per-user, unlike `rdc`, which is user-specific. nullable: true enum: - Vertifi - Ensenta rdc: type: boolean description: True if Remote deposit capture is enabled default: false rdcDisclaimer: type: string description: Disclaimer text rdcOnboardingEnabled: type: boolean description: True if RDC Onboarding is allowed rdcOnboardingByAccountsEnabled: type: boolean description: True if RDC onboarding by account is enabled billPay: type: boolean description: True if Bill pay is enabled billPaySync: type: boolean description: "Indicates enabled method(s) for fetching new bill-pay data (payees, payments, bill-pay accounts): `false` => bill pay sync is enabled on [`PUT /users/{userId}/fetch`](../../user/details/#/Account%20Aggregat\ ion/put_users__userId__fetch) `true` => may use [`POST /v0/users/{userId}/billpay/fetch`](../../billpay/retrieval/)" accountToAccount: type: boolean description: True if account to account transfers are enabled schedulableTransfers: type: boolean description: True if schedulable transfers are enabled transferHoursMessage: type: string description: Displays transfer hours to the end user in a string separateBillPayAccounts: type: boolean description: True if allowed to bill pay accounts externalAccounts: type: boolean description: True if access to external accounts is allowed alternateAccountTransferFlow: type: boolean deprecated: true description: >- True if alternate account transfer flow is enabled. This value is always true, which is why it is deprecated. payeeCreation: type: boolean description: True if allowed to create a payee p2pEnabled: type: boolean description: True if Person to Person payments is enabled sessionExpirationTimeoutMinutes: type: integer description: Time until a session will timeout in minutes sessionResumptionMethod: type: string description: Returns PIN, Username/Password, None, or User defined paymentCardManagement: type: boolean description: True if payment card management is enabled recurringTransactions: type: boolean description: True if recurring transactions are enabled canEditMFAQuestions: type: boolean description: True if allowed to Edit a user's Multi-factor authentication questions requiresUserProfile: type: boolean description: >- True if Institution requires user profile. This isn't really an ability. It is `true` for any institution which has an `aggregationType` equal to "Online Banking" and otherwise always false. checkImagesEnabled: type: boolean description: True if RDC is enabled switchUserEnabled: type: boolean description: True is user switching is enabled twoFAEnabled: type: boolean description: True if 2-Factor Authentication is enabled externalTransferOutbound: type: boolean description: True if there is a pending outbound transfer outside of the institution externalTransferInbound: type: boolean description: True if there is a pending inbound transfer outside of the institution runningBalance: type: string enum: - Disabled - Posted - All description: Returns "Disabled", "Posted", or "All" cutOffTime: type: string description: >- Cut off time for deposits. The field is `null` when no cutOffTime is defined. Note, this is currently formatted to ensure that there are no more than 3 fractional second values. This is to ease compatibility with parsers which are not fully conformant to ISO 8601/RFC 3339. Clients of this code SHOULD be able to handle any number of second fractional digits and they SHOULD NOT rely on there being no more than 3 fractional second values. format: date-time example: 1970-01-01T00:00:00.00000014+01:00 additionalMessage: type: string description: Field null when no additionalMessage is defined documents: type: boolean description: True if documents is enabled for the institution documentAbilities: type: object description: DEPRECATED deprecated: true properties: enrollment: type: boolean description: >- The value of enrollment should no longer be used for any logic. documents: type: boolean description: DEPRECATED in favor of the top-level 'documents' ability passwordManagement: type: boolean description: True if password management is enabled twoFAPhoneValidation: type: boolean description: True if 2FA phone validation is enabled memberToMemberTransfers: type: boolean description: True if enabled for the CU conversations: type: boolean description: True if conversations is fully enabled allowSSNSignup: type: boolean description: True if the SSN + account number signup flow is enabled. selfEnrollment: type: boolean description: True if the user is allowed to enroll themselves via the app. exportTransactionsEnabled: type: boolean description: True if transaction exports are enabled. alertsEnabled: type: boolean description: True if alerts are enabled. billPayEnrollment: type: boolean description: True if bill pay enrollment is enabled. selfRecovery: type: boolean description: True if the user is able to perform Self Recovery. account_jx_meta: type: boolean description: True if jXchange account meta data is enabled account_pscu_meta: type: boolean description: True if pscu account meta data is enabled account_symx_meta: type: boolean description: True if symxchange account meta data is enabled changeUsername: type: boolean description: True if the user is able to change his/her username changeEmail: type: boolean description: True if the user is able to change his/her email changePhone: type: boolean description: True if the user is able to change his/her phone changeAddress: type: string description: Specifies if/how the user is able to change their address. * `None` - Can't change their address. * `Conversations` - Can change their address only by opening a Banno Conversation. * `Direct` - Can change their address directly via the API. Does not exclude opening a Banno Conversation as backup if direct change fails and institution has the ability to open a Banno Conversation. enum: - None - Conversations - Direct changeAccountName: type: boolean description: True if the user is able to change the names of their accounts stopPayments: type: boolean description: True if stop payments is enabled zelle: type: string description: Zelle features enabled enum: - None - Send - Request - Split zelleReadyContact: type: boolean description: True if zelle ready contact feature is enabled payeeDeletion: type: boolean deprecated: true description: >- True if user is able to delete payees. This value is now defined to always be identical to the value of billPay which is why it is deprecated. payeeEdit: type: boolean deprecated: true description: >- True if user is able to edit payees. True if user is able to delete payees. This value is now defined to always be identical to the value of billPay which is why it is deprecated. advancedCardControls: type: boolean description: True if user should be able to use OnDot features payeeEditP2PSMS: type: boolean description: True if iPay has necessary settings enabled to allow P2PSMS payee types, must be manually enabled account_rewards: type: boolean description: True if account rewards is enabled travelNotices: type: boolean description: True if an institution supports card travel notices coreOfflineSupport: type: boolean description: FI supports login if the core is down, as well as notifying the user that their core is offline. Note that features will be limited. adsEnabled: type: boolean description: True if institution supports banno online ad delivery. mobileAdsEnabled: type: boolean description: True if institution supports mobile ad delivery. fullServiceCreditCardPayments: type: boolean description: True if web-view internal only credit card payments are enabled distinctBusinessProfiles: type: boolean description: True if the user's business profile information, like business name and contact info, is treated as distinct from the user's own profile information. ach: type: boolean description: True if institution supports ACH (Automated clearing house). wires: type: boolean description: True if institution supports Wire Transfers. enforceBSLEntitlements: type: boolean description: True if BSL entitlements should be enforced userManagement: type: boolean description: True if institution supports user management by organization admins and the specific user is enabled for it, too. positivePay: type: boolean description: True if Positive Pay is supported geezeoInsights: type: boolean description: True if Geezeo Insights is enabled payAnIndividualBillPay: type: boolean description: True if Pay An Individual Payees are supported (PersonElectronic, PersonCheck) creditCardControls: type: boolean description: True if basic card controls(activate, reorder, report lost/stolen) are allowed for credit cards creditCardPayments: type: boolean description: True if native credit card payments (including autopay and external payments) are enabled geezeoWheel: type: boolean description: True if pie chart is enabled to show spending habits. geezeoTrx: type: boolean description: True if clients should shows transaction categories from geezeo. thirdPartyAccounts: type: boolean description: True if clients should show Finicity accounts and transactions. videoChat: type: boolean description: True if the institution supports the video chat functionality in conversations enableAchHolds: type: boolean description: True if the institution supports ACH holds functionality enableAchPrenotes: type: boolean description: True if the institution supports ACH prenote functionality enableAchRecurringBatches: type: boolean description: True if the institution supports ACH recurring batches functionality enableAchTaxPayments: type: boolean description: True if the institution supports ACH tax payments functionality enableCopyBatch: type: boolean deprecated: true description: True if the institution supports ACH copy batch functionality. Update 09/11/2024 - This ability has been superseded by the per batch entitlement `copyBatch`. enableCopyHistoricalBatch: type: boolean description: True if the institution supports ACH copy historical batch functionality achDisplayBulkInitiate: type: boolean description: True if the institution supports ACH Bulk Initiate Batches functionality achDisplayResetRecords: type: boolean description: True if the institution supports resetting the record transaction dollar amounts to the zero value at initiation. Banks can reset records amounts to zero at initiation, but this is not applicable for CUs. achApprovalsRequireInitiate: type: boolean description: >- Determines if a user initiating an ach batch with approvals needs to provide an offset account and effective date, or if they can initiate with an effective date and offset account provided by a previous approver allowInternationalUsdWires: type: boolean description: >- True if the institution supports international USD wires. This is a separate ability from wires, as it is possible to support domestic wires but not international USD wires. wiresInitiateWithJHW: type: boolean description: True if the institution supports initiating wires through Jack Henry Wires. achBatchDownload: type: boolean description: True if the institution supports retrieving nacha file information achEntitlementModel: type: string enum: - Disabled - UserModel description: >- Determines if information associated with an entity (ex. user) should be displayed when certain entity's entitlements are enabled. achDisplayResetRecordsWhenCopyingBatch: type: boolean description: True if the institution supports resetting the record transaction dollar amounts to the zero value on the copied ach batch. moovPushToCard: type: boolean description: True if the institution supports sending money to an external card via Moov. moovPullFromCard: type: boolean description: True if the institution supports pulling money from an external card via Moov. ediTransactionDetails: type: boolean description: True if the institution supports downloading EDI (Electronic Data Interchange) Transaction Details. spendingBreakdown: type: boolean description: True if the institution supports spending breakdown. changeUisPhone: type: boolean description: True if a user is allowed to change uis phone. changeUisEmail: type: boolean description: True if a user is allowed to change uis email. payReturnAllExceptions: type: boolean description: True if the institution supports Pay All and Return All for Check and ACH exceptions. pospayExceptionCorrection: type: boolean description: True if the institution supports Positive Pay exception corrections. cashManagementReports: type: boolean description: True if the institution supports cash management reports. approveUsers: type: boolean description: True if the institution forces manual FI approval before sending a user invite to an organization. changeOrganizationEmail: type: boolean description: True if the institution supports changing the organization email. changeOrganizationPhone: type: boolean description: True if the institution supports changing the organization phone. cardHubMobileSDK: type: boolean description: True if the institution supports Fiserv CardHub mobile SDK integration. merchantAcquisition: type: boolean description: True if the institution supports Merchant Acquisition (Moov). displayCutoffTimes: type: boolean description: True if the institution allows organization users to see and change the cutoff time selfServiceForms: type: boolean description: True if the institution supports conversation forms. businessRdc: type: boolean description: True if the institution supports business remote deposit capture. warningCodes: type: boolean description: True if the institution supports warning codes. screenShare: type: boolean description: True if the institution supports screen sharing. availableTransferFrequencies: type: array items: type: string enum: - Once - Interval - SemiMonthly description: List of available scheduled transfer frequencies supported by the FI's core externalTransferSettings: type: object description: Settings for external transfers required: - currentDailyInboundTotal - currentDailyOutboundTotal - currentDailyInboundQuantity - currentDailyOutboundQuantity - cutOffTime - transferCutOffLocalTime properties: inboundFee: type: string description: Defaults to 0, field null when no fee is defined outboundFee: type: string description: Defaults to 0, field null when no fee is defined dailyInboundLimit: type: string description: Field not present when no limit is defined. dailyOutboundLimit: type: string description: Field not present when no limit is defined. dailyInboundQuantitativeLimit: type: integer description: Field not present when no limit is defined. dailyOutboundQuantitativeLimit: type: integer description: Field not present when no limit is defined. currentDailyInboundTotal: type: string description: This field has no meaning at the institution level and should not be used. deprecated: true currentDailyOutboundTotal: type: string description: This field has no meaning at the institution level and should not be used. deprecated: true currentDailyInboundQuantity: type: integer description: This field has no meaning at the institution level and should not be used. deprecated: true currentDailyOutboundQuantity: type: integer description: This field has no meaning at the institution level and should not be used. deprecated: true cutOffTime: type: string description: >- The time after which transfers should be cut off. This value is formatted as a date-time for legacy reasons, but the date portion of the value should be ignored. The zone information, currently always `Z` (UTC) should also be ignored. This value should be interpreted as the local time with respect to the institution's canonical time zone value on a given calendar day. This value should not be confused with the "cutOffTime" returned in the `.abilities` object which refers to the cutoff time for deposits. This is clearly confusing, which is why this field is deprecated. You should use transferCutOffLocalTime instead. Note, this is currently formatted to ensure that there are no more than 3 fractional second values. This is to ease compatibility with parsers which are not fully conformant to ISO 8601/RFC 3339. Clients of this code SHOULD be able to handle any number of second fractional digits and they SHOULD NOT rely on there being no more than 3 fractional second values. format: date-time example: 1970-01-01T09:08:31.917927588Z deprecated: true transferCutOffLocalTime: type: string description: >- The local time with respect to the institutions canonical time zone after which transfers should be cut off. This is formally the "partial-time" as defined by RFC 3339. (https://tools.ietf.org/html/rfc3339#section-5.6) When dealing with this value, remember to consider if the institution's canonical time zone is affected by daylight savings time. In such cases you must also discriminate on the current date to unambiguously determine the transfer cutoff time. Note, this is currently formatted to ensure that there are no more than 3 fractional second values. This is to ease compatibility with parsers which are not fully conformant to ISO 8601/RFC 3339. Clients of this code SHOULD be able to handle any number of second fractional digits and they SHOULD NOT rely on there being no more than 3 fractional second values. format: partial-time example: 09:06:28 additionalMessage: type: string description: Field null when no additionalMessage is defined inboundHighRiskThreshold: type: string description: Currency string. If set, applies threshold to all inbound external transfers outboundHighRiskThreshold: type: string description: Currency string. If set, applies threshold to all outbound external transfers cutOffTimeMessage: type: string description: A message to display information to the user about when transfers may be cut off for the day example: Transfers completed after {{cutOff-time}} will be processed the next business day. balanceDisplaySettings: type: array items: type: object required: - type - label - visible - primary properties: type: type: string enum: - Balance - AvailableBalance description: One and only one set of settings per balance calculation type label: type: string description: Label to use in the UI for the balance visible: type: boolean description: Primary balance is always visible primary: type: boolean description: One and only one primary balance cardManagementAbilities: type: array items: type: string enum: - ReOrderCard - Activate - Lost - Stolen description: Card management abilities accountTypes: type: array items: type: string description: The name of an allowed account type, like Savings, Checking, Loan, etc description: Types of allowed accounts eula: type: object description: Can be null required: - id - text - date properties: id: type: string example: 33333333-3333-4333-2333-333333333333 description: EULA ID text: type: string description: Text shown with EULA date: type: string description: The date the eula was created format: date-time displayStrings: type: object description: description required: - rdcSignup - rdcCheckFrontText - rdcCheckBackText - cardReorderText - availableBalanceDisclosureText - transferCutOffTimeText - externalTransferCutOffTimeText - accountIdentifierLabelText - addressChangeRequestText - accountOpeningLinksLabelText - lostStolenCardText properties: rdcSignup: type: string description: Message displayed to users when signing up for RDC example: Conveniently add funds by taking photos of your check. It's easy, fast and secure. Enroll today by selecting the accounts you wish to deposit to. rdcCheckFrontText: type: string description: Message displayed to users when capturing check front images for RDC example: Place check on a flat, well-lit, surface and tap the capture button to take the photo. rdcCheckBackText: type: string description: Message displayed to users when capturing check back images for RDC example: Capture Check Back. Must contain your signature, "for mobile deposit only" and your deposit account number. cardReorderText: type: string description: Message displayed to users when re-ordering cards example: Fees may apply. availableBalanceDisclosureText: type: string description: Message displayed to users to disclose how available balances are calculated transferCutOffTimeText: type: string description: Message displayed to users explaining transfer cut-off times example: Transfers made after 5PM will be made the next business day. externalTransferCutOffTimeText: type: string description: Message displayed to users explaining external transfer cut-off times accountIdentifierLabelText: type: string description: This is the label text for the self-enrollment field where bank and credit union users enter different kinds of account identification. addressChangeRequestText: type: string description: Message displayed to users making address change requests accountOpeningLinksLabelText: type: string description: This is the label to be displayed for account opening SSOs. bannoEnrollmentText: type: string description: Message displayed to users for Banno Enrollment. bannoOfflineModeText: type: string description: Message displayed to users for Banno Offline. lostStolenCardText: type: string description: Message displayed to user before they report a card lost or stolen. theme: type: object deprecated: true nullable: true description: >- DEPRECATED. On May 7th 2026 this object may be returned as null or with fallback/dummy values. The source of data backing this is no longer updated and does not reflect the Institution's current theme settings. Please call /v0/institutions/{institutionId}/themes instead. required: - institutionId - backgroundPortraitAlignment - backgroundLandscapeAlignment - bodyHeaderBackgroundColor - bodyHeaderTitleColor - bodyHeaderIconColor - bodyFooterColor - loginContainerBackgroundColor - loginContainerBackgroundBlur - navigationBarColor - navigationBarBlur - navigationBarTitleColor - navigationBarIconColor - navigationBarItemTextColor - dashboardContainerBackgroundColor - dashboardContainerBackgroundBlur - secondaryPageContainerBackgroundColor - secondaryPageContainerBackgroundBlur - bodyTextPrimaryColor - bodyTextSecondaryColor - bodyTextThemeColor - bodyTextAlertColor - actionButtonColor - actionButtonPressedColor - actionButtonDisabledColor - actionButtonFocusedColor - actionButtonTextColor - actionButtonTextPressedColor - actionButtonTextDisabledColor - actionButtonTextFocusedColor - inlineButtonColor - inlineButtonPressedColor - inlineButtonDisabledColor - inlineButtonFocusedColor - inlineButtonTextColor - inlineButtonTextPressedColor - inlineButtonTextDisabledColor - inlineButtonTextFocusedColor - pinDotColor - inputPlaceholderTextColor - inputEnteredTextColor - stepIndicatorActiveColor - stepIndicatorInactiveColor - primaryIconBackgroundColor - primaryIconColor - secondaryIconBackgroundColor - secondaryIconColor - controllerViewBackgroundColor - errorBackgroundColor - errorTextColor - cardTitleTextColor - accountCardBackgroundPrimaryColor - accountCardBackgroundSecondaryColor - contactButtonColor - contactButtonPressedColor - contactButtonDisabledColor - contactButtonFocusedColor - contactButtonIconColor - contactButtonIconPressedColor - contactButtonIconDisabledColor - contactButtonIconFocusedColor - contactButtonTextColor - contactButtonTextPressedColor - contactButtonTextDisabledColor - contactButtonTextFocusedColor - magneticAdBackgroundColor - magneticAdTextColor - menuBackgroundColor - menuItemColor - menuItemPressedColor - menuItemDisabledColor - menuItemFocusedColor - menuIconColor - menuIconPressedColor - menuIconDisabledColor - menuIconFocusedColor - menuIconBackgroundColor - menuIconBackgroundPressedColor - menuIconBackgroundDisabledColor - menuIconBackgroundFocusedColor - menuTextColor - menuTextPressedColor - menuTextDisabledColor - menuTextFocusedColor - menuItemDividerColor - indicatorBackgroundColor - indicatorTextColor - toggleSwitchActiveColor - toggleSwitchInactiveColor - transactionListWithdrawalAmountColor - transactionListDepositAmountColor - depositAmountColor - withdrawalAmountColor - statusBarColorMode - rejectedColor - completedColor - bodyTextHighlightColor - listDividerTextColor - dividerColor - secondaryContentBackgroundColor - primaryContentBackgroundColor - inlineIconButtonColor - inlineIconButtonPressedColor - inlineIconButtonDisabledColor - inlineIconButtonFocusedColor - inlineIconBackgroundColor - inlineIconBackgroundPressedColor - inlineIconBackgroundDisabledColor - inlineIconBackgroundFocusedColor - inlineIconColor - inlineIconPressedColor - inlineIconDisabledColor - inlineIconFocusedColor - inlineIconTextColor - inlineIconTextPressedColor - inlineIconTextDisabledColor - inlineIconTextFocusedColor - accountCardPrimaryTextColor - accountCardSecondaryTextColor - statusBarColor - toolbarColor - toolbarTitleColor - toolbarIconColor - statusBarActionModeColor - toolbarActionModeColor - toolbarActionModeTitleColor - toolbarActionModeIconColor properties: institutionId: type: string description: >- UUID ID of the institution. This will always be the same path variable used to lookup the user or institution level details. This makes this data redundant, which is why the field is deprecated. deprecated: true format: uuid example: 00000000-0000-0000-0000-000000000000 lastUpdated: type: string format: date-time description: >- ISO 8601/RFC 3339 Date Time value. Note, this is currently formatted to ensure that there are no more than 3 fractional second values. This is to ease compatibility with parsers which are not fully conformant to ISO 8601/RFC 3339. Clients of this code SHOULD be able to handle any number of second fractional digits and they SHOULD NOT rely on there being no more than 3 fractional second values. If an institution is using the default theme, this value will not be present. example: 1970-01-01T00:00:00.00000014+01:00 backgroundPortraitAlignment: type: string description: Background Image Alignment example: (left, center, right) backgroundLandscapeAlignment: type: string description: Background Image Alignment example: (top, center, bottom) bodyHeaderBackgroundColor: type: string description: Body header used in login panels and overlays bodyHeaderTitleColor: type: string description: Body header used in login panels and overlays bodyHeaderIconColor: type: string description: Body header used in login panels and overlays bodyFooterColor: type: string description: Footer container loginContainerBackgroundColor: type: string description: Login outer container loginContainerBackgroundBlur: type: string description: Login outer container navigationBarColor: type: string description: Navigation bar used for Action Bar (Android) / Navigation Bar (iOS) navigationBarBlur: type: string description: Navigation bar used for Action Bar (Android) / Navigation Bar (iOS) navigationBarTitleColor: type: string description: Navigation bar used for Action Bar (Android) / Navigation Bar (iOS) navigationBarIconColor: type: string description: Navigation bar used for Action Bar (Android) / Navigation Bar (iOS) navigationBarItemTextColor: type: string description: Navigation bar used for Action Bar (Android) / Navigation Bar (iOS) dashboardContainerBackgroundColor: type: string description: Dashboard Background dashboardContainerBackgroundBlur: type: string description: Dashboard Background secondaryPageContainerBackgroundColor: type: string description: Secondary Page Background secondaryPageContainerBackgroundBlur: type: string description: Secondary Page Background bodyTextPrimaryColor: type: string description: Body Text Properties bodyTextSecondaryColor: type: string description: Body Text Properties bodyTextThemeColor: type: string description: Body Text Properties bodyTextAlertColor: type: string description: Body Text Properties actionButtonColor: type: string description: Call to Action button actionButtonPressedColor: type: string description: Call to Action button actionButtonDisabledColor: type: string description: Call to Action button actionButtonFocusedColor: type: string description: Call to Action button actionButtonTextColor: type: string description: Call to Action button actionButtonTextPressedColor: type: string description: Call to Action button actionButtonTextDisabledColor: type: string description: Call to Action button actionButtonTextFocusedColor: type: string description: Call to Action button inlineButtonColor: type: string description: Inline button used for "Forget?" and "Skip" links on login inlineButtonPressedColor: type: string description: Inline button used for "Forget?" and "Skip" links on login inlineButtonDisabledColor: type: string description: Inline button used for "Forget?" and "Skip" links on login inlineButtonFocusedColor: type: string description: Inline button used for "Forget?" and "Skip" links on login inlineButtonTextColor: type: string description: Inline button used for "Forget?" and "Skip" links on login inlineButtonTextPressedColor: type: string description: Inline button used for "Forget?" and "Skip" links on login inlineButtonTextDisabledColor: type: string description: Inline button used for "Forget?" and "Skip" links on login inlineButtonTextFocusedColor: type: string description: Inline button used for "Forget?" and "Skip" links on login pinDotColor: type: string description: Pin dot used for pin entry inputPlaceholderTextColor: type: string description: Form inputs inputEnteredTextColor: type: string description: Form inputs stepIndicatorActiveColor: type: string description: Login step indicator stepIndicatorInactiveColor: type: string description: Login step indicator primaryIconBackgroundColor: type: string description: Dashboard Card Icons primaryIconColor: type: string description: Dashboard Card Icons secondaryIconBackgroundColor: type: string description: Dashboard Card Icons secondaryIconColor: type: string description: Dashboard Card Icons controllerViewBackgroundColor: type: string description: Theme Loading (used before theme has downloaded in iOS) errorBackgroundColor: type: string description: Error/Warning Messages errorTextColor: type: string description: Error/Warning Messages cardTitleTextColor: type: string description: Dashboard Cards Title accountCardBackgroundPrimaryColor: type: string description: Accounts Balance Card accountCardBackgroundSecondaryColor: type: string description: Accounts Balance Card contactButtonColor: type: string description: Contact Card Buttons contactButtonPressedColor: type: string description: Contact Card Buttons contactButtonDisabledColor: type: string description: Contact Card Buttons contactButtonFocusedColor: type: string description: Contact Card Buttons contactButtonIconColor: type: string description: Contact Card Buttons contactButtonIconPressedColor: type: string description: Contact Card Buttons contactButtonIconDisabledColor: type: string description: Contact Card Buttons contactButtonIconFocusedColor: type: string description: Contact Card Buttons contactButtonTextColor: type: string description: Contact Card Buttons contactButtonTextPressedColor: type: string description: Contact Card Buttons contactButtonTextDisabledColor: type: string description: Contact Card Buttons contactButtonTextFocusedColor: type: string description: Contact Card Buttons magneticAdBackgroundColor: type: string description: Magnetic Ads magneticAdTextColor: type: string description: Magnetic Ads menuBackgroundColor: type: string description: List background color to be applied above background image menuItemColor: type: string description: Menu button background menuItemPressedColor: type: string description: Menu button background menuItemDisabledColor: type: string description: Menu button background menuItemFocusedColor: type: string description: Menu button background menuIconColor: type: string description: Menu button icon graphic (png image) menuIconPressedColor: type: string description: Menu button icon graphic (png image) menuIconDisabledColor: type: string description: Menu button icon graphic (png image) menuIconFocusedColor: type: string description: Menu button icon graphic (png image) menuIconBackgroundColor: type: string description: Menu icon background (circle) menuIconBackgroundPressedColor: type: string description: Menu icon background (circle) menuIconBackgroundDisabledColor: type: string description: Menu icon background (circle) menuIconBackgroundFocusedColor: type: string description: Menu icon background (circle) menuTextColor: type: string description: Menu button text color. menuTextPressedColor: type: string description: Menu button text color menuTextDisabledColor: type: string description: Menu button text color menuTextFocusedColor: type: string description: Menu button text color. Also used for FI name above FI buttons menuItemDividerColor: type: string description: Menu divider line indicatorBackgroundColor: type: string description: Inbox Indicator indicatorTextColor: type: string description: Inbox Indicator toggleSwitchActiveColor: type: string description: Toggle Switch toggleSwitchInactiveColor: type: string description: Toggle Switch transactionListWithdrawalAmountColor: type: string description: Transaction List transactionListDepositAmountColor: type: string description: Transaction List depositAmountColor: type: string description: Deposit Amount withdrawalAmountColor: type: string description: Withdrawal Amount statusBarColorMode: type: string description: Status Bar rejectedColor: type: string description: "" completedColor: type: string description: "" bodyTextHighlightColor: type: string description: Body text highlight listDividerTextColor: type: string description: List Divider dividerColor: type: string description: Divider secondaryContentBackgroundColor: type: string description: Secondary content background primaryContentBackgroundColor: type: string description: Primary content background inlineIconButtonColor: type: string description: Inline button inlineIconButtonPressedColor: type: string description: Inline icon button inlineIconButtonDisabledColor: type: string description: Inline icon button inlineIconButtonFocusedColor: type: string description: Inline icon button inlineIconBackgroundColor: type: string description: Inline icon inlineIconBackgroundPressedColor: type: string description: Inline icon inlineIconBackgroundDisabledColor: type: string description: Inline icon inlineIconBackgroundFocusedColor: type: string description: Inline icon inlineIconColor: type: string description: Inline icon inlineIconPressedColor: type: string description: Inline icon inlineIconDisabledColor: type: string description: Inline icon inlineIconFocusedColor: type: string description: Inline icon inlineIconTextColor: type: string description: Inline icon inlineIconTextPressedColor: type: string description: Inline icon text inlineIconTextDisabledColor: type: string description: Inline icon text inlineIconTextFocusedColor: type: string description: Inline icon text accountCardPrimaryTextColor: type: string description: Account card accountCardSecondaryTextColor: type: string description: Account card statusBarColor: type: string description: Status bar toolbarColor: type: string description: Toolbar toolbarTitleColor: type: string description: Toolbar toolbarIconColor: type: string description: Toolbar icon statusBarActionModeColor: type: string description: Status bar toolbarActionModeColor: type: string description: Toolbar toolbarActionModeTitleColor: type: string description: Toolbar toolbarActionModeIconColor: type: string description: Toolbar localTimezone: type: string description: >- Not present if FI timezone not found. Provided in seconds offset UTC. This value is deprecated because it is calculated using a static time 1970-01-01T00:00:00Z which does not account for daylight savings time. Please use zoneId instead. deprecated: true example: "-28800" zoneId: type: string description: >- IANA timezone value for the institution. example: "America/Chicago" links: type: array items: $ref: "#/components/schemas/institutionLink" description: See Links documentation for more information staticLinks: type: array items: $ref: "#/components/schemas/institutionStaticLink" description: A list of links that have a preset URL. The list will be empty in the event of an upstream failure. smallBusinessSettings: deprecated: true description: >- For the Institution level details, this value is hard coded to be { "ach": false, "wire": "none" }. It is not configurable in anyway at the Institution level and will be removed from future iterations of this API. type: object required: - ach - wire properties: ach: type: boolean description: True if ACH is enabled wire: type: string description: Single if wires can be transmitted, dual if wires can be transmitted and approved enum: - none - single - dual stopPaymentsSettings: type: object deprecated: true description: Settings that contain field level controls around presenting a form for stop payment creation. Although this is a required field, the members of this object may not be present, which is why it is deprecated. Please use the optional stopPayments object instead. properties: payeeEntry: type: string description: Indicates whether the payee field is optional, required, or unsupported for creation enum: - Required - Optional - Unsupported amountEntry: type: string description: Indicates whether the amount field is optional, required, or unsupported for creation enum: - Required - Optional - Unsupported dateEntry: type: string description: Indicates whether the date field is optional, required, or unsupported for creation enum: - Required - Optional - Unsupported reasonEntry: type: string description: Indicates whether the reason field is optional, required, or unsupported for creation enum: - Required - Optional - Unsupported disclaimer: type: string description: Disclaimer for stop payment creation fee: type: string example: "25.00" description: "Field not present when no fee defined. Format: ([1-9]\\d{0,2}(\\,\\d{3})*|0)\\.\\d{2}" stopPayments: type: object description: Settings that contain field level controls around presenting a form for stop payment creation required: - payeeEntry - amountEntry - dateEntry - reasonEntry - disclaimer properties: payeeEntry: type: string description: Indicates whether the payee field is optional, required, or unsupported for creation enum: - Required - Optional - Unsupported amountEntry: type: string description: Indicates whether the amount field is optional, required, or unsupported for creation enum: - Required - Optional - Unsupported dateEntry: type: string description: Indicates whether the date field is optional, required, or unsupported for creation enum: - Required - Optional - Unsupported reasonEntry: type: string description: Indicates whether the reason field is optional, required, or unsupported for creation enum: - Required - Optional - Unsupported disclaimer: type: string description: Disclaimer for stop payment creation fee: type: string example: "25.00" description: "Field not present when no fee defined. Format: ([1-9]\\d{0,2}(\\,\\d{3})*|0)\\.\\d{2}" isCashManagement: type: boolean description: Whether a user is cash management. Field will not present for non-user-specific institution abilities. regDSettings: type: object description: Regulation D settings for the institution required: - limitsText - countTotal properties: limitsText: type: string description: This is the text to be displayed for regulation D limited accounts. countTotal: type: integer example: 6 description: Total allowed withdrawals from a regulation D restricted account per month transferMemos: type: object description: Available transfer types for user-provided memos for the institution properties: immediateInternal: type: boolean description: If true, allow users to provide a memo for immediate, internal transfers routingNumber: type: string description: Routing Number of the institution. It will be null in the event of an upstream failure or the FI's agg type is Aggregation. institutionLinkId: type: string description: ID to reference institution link in requests, responses and other objects format: uuid institutionLink: type: object required: - id - linkType - title - description properties: id: $ref: "#/components/schemas/institutionLinkId" linkType: type: string description: Institution level link type enum: - AccountOpening - BillPay - BrokerageTools - BudgetTools - CardFramework - CashManagement - CharitableGiving - CheckReordering - CreditCardFeatures - CreditScore - CURewards - DebtRelief - Documents - DocumentsSettings - Forms - Investments - Invoices - LoanAccountOpening - ManageCreditCard - Netteller - PayrollProtectionProgram - PowerChangeAddress - PowerLoanApplication - PowerShare - PowerSkipPayment - ResponsiveBillPay - RewardsMain - Testing - TextBanking title: type: string description: Title of the link description: type: string description: Longer description of the link name: type: string description: Name of the SSO provider fdicNotice: type: string description: FDIC (Federal Deposit Insurance Corporation) notice text to display to the user. institutionStaticLink: type: array items: type: object required: - linkType - label - url properties: linkType: type: string description: Link type enum: - NetNewAccount label: type: string description: Label applied for the link example: Check out Banno url: type: string description: The fully qualified URL for this link. format: uri example: https://banno.com/ institutionAppInfo: type: object properties: minimumVersions: type: object properties: android: type: string example: "20440099" description: The minimum version code that the Android application must be to correctly and securely communicate with the API iOS: type: string example: 2.2.0 description: The minimum version that the iOS application must be to correctly and securely communicate with the API migration: type: object required: - androidApp - iOSApp - message - blockLevel properties: androidApp: type: string example: com.banno.grip description: The package name for the Android app to migrate to iOSApp: type: string example: "1234567890" description: The App Store identifier for the iOS app to migrate to message: type: string example: Please install this other app. We're sure it's just as good... description: The institution configurable message to display to the user when prompted blockLevel: type: string enum: - None - Soft - Hard description: What level of blocking should the client present to the user. None means no prompt. Soft means a dismissible prompt to allow the user to continue using the app. Hard means a totally blocking prompt that will not allow the user to continue using the app. institutionThemes: type: object required: - default - additionalThemes properties: default: allOf: - $ref: "#/components/schemas/themeInfo" - type: object properties: name: enum: - default additionalThemes: type: array items: allOf: - $ref: "#/components/schemas/themeInfo" - type: object properties: name: example: vip themeInfo: type: object required: - name - light properties: name: type: string description: Name of the theme light: $ref: "#/components/schemas/themeValues" dark: $ref: "#/components/schemas/themeValues" themeValues: type: object required: - accountCardPrimaryAccentColor - accountCardPrimaryBackgroundColor - accountCardPrimaryTextColor - accountCardSecondaryAccentColor - accountCardSecondaryBackgroundColor - accountCardSecondaryTextColor - actionCardAccentColor - actionCardBackgroundColor - actionCardTextColor - androidGestureBarColor - androidGestureBarMode - bodyTextAlertColor - bodyTextCompletedColor - bodyTextDepositColor - bodyTextHighlightColor - bodyTextPrimaryColor - bodyTextRejectedColor - bodyTextSecondaryColor - bodyTextThemeColor - buttonCornerRadius - cardCornerRadius - cardShadow - cardTitleTextColor - dashboardNavigationBarLogo - dashboardPageBackgroundColor - defaultButtonBorderColor - defaultButtonBorderDisabledColor - defaultButtonBorderFocusedColor - defaultButtonBorderPressedColor - defaultButtonColor - defaultButtonDisabledColor - defaultButtonFocusedColor - defaultButtonPressedColor - defaultButtonTextColor - defaultButtonTextDisabledColor - defaultButtonTextFocusedColor - defaultButtonTextPressedColor - dividerAlternativeColor - dividerDefaultColor - errorBackgroundColor - errorTextColor - footerBackgroundColor - footerLinkTextColor - footerTextColor - heroEmptyCardColor - heroGradientColors - heroStatusBarMode - heroTextColor - indicatorBackgroundColor - indicatorTextColor - inlineIconBackgroundColor - inlineIconColor - institutionId - lastUpdated - linkButtonFocusedColor - linkButtonPressedColor - linkButtonTextColor - linkButtonTextDisabledColor - linkButtonTextFocusedColor - linkButtonTextPressedColor - menuBackgroundColor - menuDividerColor - menuIconBackgroundColor - menuIconBackgroundDisabledColor - menuIconBackgroundPressedColor - menuIconBackgroundSelectedColor - menuIconColor - menuIconDisabledColor - menuIconPressedColor - menuIconSelectedColor - menuItemColor - menuItemDisabledColor - menuItemPressedColor - menuItemSelectedAccentColor - menuItemSelectedColor - menuTextColor - menuTextDisabledColor - menuTextPressedColor - menuTextSelectedColor - navigationBarButtonColor - navigationBarColor - navigationBarTitleColor - pinDotColor - primaryButtonColor - primaryButtonDisabledColor - primaryButtonFocusedColor - primaryButtonPressedColor - primaryButtonTextColor - primaryButtonTextDisabledColor - primaryButtonTextFocusedColor - primaryButtonTextPressedColor - primaryContentBackgroundColor - primaryThemeBackgroundColor - primaryThemeTextColor - secondaryContentBackgroundColor - secondaryPageBackgroundColor - secondaryThemeBackgroundColor - secondaryThemeTextColor - statusBarActionMode - statusBarActionModeColor - statusBarColor - statusBarMode - statusBarPrimaryBackgroundMode - toastBackgroundColor - toastTextColor - toggleSwitchActiveColor - toolbarActionModeButtonColor - toolbarActionModeColor - toolbarActionModeTitleColor - toolbarButtonColor - toolbarColor - toolbarTitleColor properties: accountCardPrimaryAccentColor: $ref: "#/components/schemas/color" accountCardPrimaryBackgroundColor: $ref: "#/components/schemas/color" accountCardPrimaryTextColor: $ref: "#/components/schemas/color" accountCardSecondaryAccentColor: $ref: "#/components/schemas/color" accountCardSecondaryBackgroundColor: $ref: "#/components/schemas/color" accountCardSecondaryTextColor: $ref: "#/components/schemas/color" actionCardAccentColor: $ref: "#/components/schemas/color" actionCardBackgroundColor: $ref: "#/components/schemas/color" actionCardTextColor: $ref: "#/components/schemas/color" androidGestureBarColor: $ref: "#/components/schemas/color" androidGestureBarMode: $ref: "#/components/schemas/iconMode" bodyTextAlertColor: $ref: "#/components/schemas/color" bodyTextCompletedColor: $ref: "#/components/schemas/color" bodyTextDepositColor: $ref: "#/components/schemas/color" bodyTextHighlightColor: $ref: "#/components/schemas/color" bodyTextPrimaryColor: $ref: "#/components/schemas/color" bodyTextRejectedColor: $ref: "#/components/schemas/color" bodyTextSecondaryColor: $ref: "#/components/schemas/color" bodyTextThemeColor: $ref: "#/components/schemas/color" buttonCornerRadius: $ref: "#/components/schemas/cornerRadius" cardCornerRadius: $ref: "#/components/schemas/cornerRadius" cardShadow: $ref: "#/components/schemas/shadow" cardTitleTextColor: $ref: "#/components/schemas/color" dashboardNavigationBarLogo: $ref: "#/components/schemas/visibility" dashboardPageBackgroundColor: $ref: "#/components/schemas/color" defaultButtonBorderColor: $ref: "#/components/schemas/color" defaultButtonBorderDisabledColor: $ref: "#/components/schemas/color" defaultButtonBorderFocusedColor: $ref: "#/components/schemas/color" defaultButtonBorderPressedColor: $ref: "#/components/schemas/color" defaultButtonColor: $ref: "#/components/schemas/color" defaultButtonDisabledColor: $ref: "#/components/schemas/color" defaultButtonFocusedColor: $ref: "#/components/schemas/color" defaultButtonPressedColor: $ref: "#/components/schemas/color" defaultButtonTextColor: $ref: "#/components/schemas/color" defaultButtonTextDisabledColor: $ref: "#/components/schemas/color" defaultButtonTextFocusedColor: $ref: "#/components/schemas/color" defaultButtonTextPressedColor: $ref: "#/components/schemas/color" dividerAlternativeColor: $ref: "#/components/schemas/color" dividerDefaultColor: $ref: "#/components/schemas/color" errorBackgroundColor: $ref: "#/components/schemas/color" errorTextColor: $ref: "#/components/schemas/color" footerBackgroundColor: $ref: "#/components/schemas/color" footerLinkTextColor: $ref: "#/components/schemas/color" footerTextColor: $ref: "#/components/schemas/color" heroEmptyCardColor: $ref: "#/components/schemas/color" heroGradientColors: description: Gradient of 3 colors over the hero section, where the array is [start, middle, end] of the gradient. items: $ref: "#/components/schemas/color" maxItems: 3 minItems: 3 type: array heroStatusBarMode: $ref: "#/components/schemas/iconMode" heroTextColor: $ref: "#/components/schemas/color" indicatorBackgroundColor: $ref: "#/components/schemas/color" indicatorTextColor: $ref: "#/components/schemas/color" inlineIconBackgroundColor: $ref: "#/components/schemas/color" inlineIconColor: $ref: "#/components/schemas/color" institutionId: type: string description: Institution ID lastUpdated: type: string description: Date time string, last updated linkButtonFocusedColor: $ref: "#/components/schemas/color" linkButtonPressedColor: $ref: "#/components/schemas/color" linkButtonTextColor: $ref: "#/components/schemas/color" linkButtonTextDisabledColor: $ref: "#/components/schemas/color" linkButtonTextFocusedColor: $ref: "#/components/schemas/color" linkButtonTextPressedColor: $ref: "#/components/schemas/color" menuBackgroundColor: $ref: "#/components/schemas/color" menuDividerColor: $ref: "#/components/schemas/color" menuIconBackgroundColor: $ref: "#/components/schemas/color" menuIconBackgroundDisabledColor: $ref: "#/components/schemas/color" menuIconBackgroundPressedColor: $ref: "#/components/schemas/color" menuIconBackgroundSelectedColor: $ref: "#/components/schemas/color" menuIconColor: $ref: "#/components/schemas/color" menuIconDisabledColor: $ref: "#/components/schemas/color" menuIconPressedColor: $ref: "#/components/schemas/color" menuIconSelectedColor: $ref: "#/components/schemas/color" menuItemColor: $ref: "#/components/schemas/color" menuItemDisabledColor: $ref: "#/components/schemas/color" menuItemPressedColor: $ref: "#/components/schemas/color" menuItemSelectedAccentColor: $ref: "#/components/schemas/color" menuItemSelectedColor: $ref: "#/components/schemas/color" menuTextColor: $ref: "#/components/schemas/color" menuTextDisabledColor: $ref: "#/components/schemas/color" menuTextPressedColor: $ref: "#/components/schemas/color" menuTextSelectedColor: $ref: "#/components/schemas/color" navigationBarButtonColor: $ref: "#/components/schemas/color" navigationBarColor: $ref: "#/components/schemas/color" navigationBarTitleColor: $ref: "#/components/schemas/color" pinDotColor: $ref: "#/components/schemas/color" primaryButtonColor: $ref: "#/components/schemas/color" primaryButtonDisabledColor: $ref: "#/components/schemas/color" primaryButtonFocusedColor: $ref: "#/components/schemas/color" primaryButtonPressedColor: $ref: "#/components/schemas/color" primaryButtonTextColor: $ref: "#/components/schemas/color" primaryButtonTextDisabledColor: $ref: "#/components/schemas/color" primaryButtonTextFocusedColor: $ref: "#/components/schemas/color" primaryButtonTextPressedColor: $ref: "#/components/schemas/color" primaryContentBackgroundColor: $ref: "#/components/schemas/color" primaryThemeBackgroundColor: $ref: "#/components/schemas/color" primaryThemeTextColor: $ref: "#/components/schemas/color" secondaryContentBackgroundColor: $ref: "#/components/schemas/color" secondaryPageBackgroundColor: $ref: "#/components/schemas/color" secondaryThemeBackgroundColor: $ref: "#/components/schemas/color" secondaryThemeTextColor: $ref: "#/components/schemas/color" statusBarActionMode: $ref: "#/components/schemas/iconMode" statusBarActionModeColor: $ref: "#/components/schemas/color" statusBarColor: $ref: "#/components/schemas/color" statusBarMode: $ref: "#/components/schemas/iconMode" statusBarPrimaryBackgroundMode: $ref: "#/components/schemas/iconMode" toastBackgroundColor: $ref: "#/components/schemas/color" toastTextColor: $ref: "#/components/schemas/color" toggleSwitchActiveColor: $ref: "#/components/schemas/color" toolbarActionModeButtonColor: $ref: "#/components/schemas/color" toolbarActionModeColor: $ref: "#/components/schemas/color" toolbarActionModeTitleColor: $ref: "#/components/schemas/color" toolbarButtonColor: $ref: "#/components/schemas/color" toolbarColor: $ref: "#/components/schemas/color" toolbarTitleColor: $ref: "#/components/schemas/color" color: type: string pattern: "#[0-9A-F]{8}" description: "Is of the format #RRGGBBAA. R (red), G (green), B (blue), and A (alpha) are hexadecimal characters (0-9, A-F)." example: "#9900AAFF" cornerRadius: type: integer description: Corner radius. To be consumed as pixels for Web, pt for iOS, and DIP for Android example: 8 shadow: type: integer minimum: 0 maximum: 5 description: An enumeration value of shadow depth, where 0 is no shadow and 5 is a large amount of shadow. Clients are expected to translate this number into a platform specific value. example: 4 iconMode: type: string enum: - Light - Dark description: Direction to clients for applying a color mode to the designated icons visibility: type: string enum: - Hide - Show description: Direction to clients whether to hide or show the designated element