Digital Banking APIs
The Candescent MCP Server exposes a beta subset of Digital Banking REST APIs as MCP tools. Each tool maps to an operation documented in the Candescent DI API reference. Your IDE discovers these tools automatically after you connect and authenticate.
The available operations and schemas may expand or change during beta. This page reflects the current MCP surface; always verify behavior in Stage or Sandbox before building production workflows.
Copy the sample prompts below into your IDE chat to invoke each tool. Replace placeholder values (<hostUserId>, <accountId>, <customerId>, <startDate>, <endDate>, and so on) with values valid in your Stage or Sandbox environment. For parameter definitions, formats, enums, and required fields, refer to the Candescent DI API reference (OpenAPI spec) and the linked operation page for each endpoint below.
Core Banking
Accounts
| MCP tool | Summary | Method | API path | REST reference |
|---|---|---|---|---|
listAccountsV1 | List Accounts | GET | /v1/accounts | List Accounts V1 |
getAccountV1 | Get Account by ID | GET | /v1/accounts/{accountId} | Get Account By ID V1 |
Typical scopes: accounts:read (optional accounts:read_unmasked for unmasked account numbers).
Common headers: Authorization: Bearer {token}, transactionId (UUID).
Transactions
| MCP tool | Summary | Method | API path | REST reference |
|---|---|---|---|---|
listTransactionsV1 | List Account Transactions | GET | /v1/transactions | List Account Transactions V1 |
Typical scopes: transactions:read (and account entitlements for the requested accounts).
Banking Images
| MCP tool | Summary | Method | API path | REST reference |
|---|---|---|---|---|
listBankingImagesV1 | List Banking Images | GET | /v1/banking-images | List Banking Images V1 |
getBankingImageV1 | Get Banking Image by ID | GET | /v1/banking-images/{bankingImageId} | Get Banking Image By ID V1 |
See the Images category for schemas and response models.
User APIs
Customer Profile and Accounts
| MCP tool | Summary | Method | API path | REST reference |
|---|---|---|---|---|
getCustomerInformation | Get Customer Profile | GET | /v1/customers/{customerId} | Get Customer Information |
getCustomerAccounts | Fetch Account Information | GET | /v1/customers/{customerId}:accounts | Get Customer Information |
Contact Methods
| MCP tool | Summary | Method | API path | REST reference |
|---|---|---|---|---|
getCustomerContactMethods | Fetch Contact Methods | GET | /v1/customers/{customerId}/contact-methods | Get Customer Contact Methods |
Electronic Statements
| MCP tool | Summary | Method | API path | REST reference |
|---|---|---|---|---|
getEstatementsReport | Fetch Opt-in Data | POST | /v1/reports/e-statements | Get E-Statements Report |
getDisclosuresByAccountId | Fetch Disclosure Information | GET | /v1/e-statements/{accountId}/disclosures | Get Disclosures By Account ID |
Sample Prompts
Use these prompts in your IDE chat with the candescent-digital-banking MCP server connected. When using client_credentials tokens, include hostUserId in your prompt — the assistant passes it to the tool as a required parameter.
Each <placeholder> in the prompts below maps to a query parameter, path parameter, or request field on the underlying REST API. Refer to the Candescent DI API OpenAPI specification — especially the REST reference link for each operation in the tables above — for details on allowed values, data types, conditionally required parameters, and mutually exclusive options (for example hostUserId vs loginId).
Accounts
List Accounts
List all accounts for user <hostUserId> using the Candescent MCP server.
Show deposit accounts only for hostUserId <hostUserId>. Use a filter for category DEPOSIT.
List accounts for user <hostUserId> with the small view (viewName s).
Get Account by ID
Get full account details for account ID <accountId> for user <hostUserId>.
Using candescent-digital-banking, get account details for account number <accountNumber> for hostUserId <hostUserId>.
Transactions
List Account Transactions
List transactions for account <accountId> for user <hostUserId> from <startDate> to <endDate>.
Show the last <count> transactions for account ID <accountId> for hostUserId <hostUserId>.
Get pending and posted transactions for account <accountId> for user <hostUserId>.
Banking Images
List Banking Images
List banking images for user <hostUserId> using the Candescent MCP server.
Show all check and deposit slip images for hostUserId <hostUserId>.
Get Banking Image by ID
Get banking image details for bankingImageId <bankingImageId> for user <hostUserId>.
Retrieve the banking image with ID <bankingImageId> for hostUserId <hostUserId>.
Customer Profile and Accounts
Get Customer Profile
Get the customer profile for customerId <customerId> for user <hostUserId>.
Using candescent-digital-banking, fetch customer information for customer ID <customerId> with hostUserId <hostUserId>.
Fetch Account Information
Fetch account registration information for customer <customerId> for user <hostUserId>.
Get all accounts linked to customerId <customerId> for hostUserId <hostUserId>, including account status and transactions.
Contact Methods
Fetch Contact Methods
Get contact methods for customer <customerId> for user <hostUserId>.
List email and phone contact methods for customerId <customerId> using the Candescent MCP server with hostUserId <hostUserId>.
Electronic Statements
Fetch Opt-in Data
Get e-statement opt-in report for user <hostUserId> for all <accountType> accounts.
Fetch e-statement opt-in preferences for hostUserId <hostUserId> filtered by account type <accountType>.
Fetch Disclosure Information
Get e-statement disclosures for account <accountId> for user <hostUserId>.
Fetch disclosure information for account ID <accountId> for hostUserId <hostUserId>.
Base URLs
MCP tools invoke the same REST APIs documented in the API reference. Use the host that matches your MCP environment:
| Environment | REST base URL |
|---|---|
| Stage | https://api.stage.candescent.com |
| Sandbox | https://api.sandbox.candescent.com |
| Production | https://api.candescent.com |
MCP beta access is limited to Stage and Sandbox. Production REST URLs are listed for reference only.
Authentication and Scopes
All underlying API calls require a valid OAuth 2.0 bearer token configured in your IDE's mcp.json under headers.Authorization. You must also include a transactionId header (UUID) in the same headers object. See Installation and Create OAuth Token (V2).
Each operation enforces the same scopes and entitlements as the REST API. If a tool call fails with 403 Forbidden, verify:
- Your app has the required OAuth scopes
- The token subject is entitled to the requested account or customer
- You are using the correct environment (Stage vs Sandbox)
Operations Not Yet in MCP
The tables above list every operation currently available as an MCP tool. Other Candescent DI API areas — such as Customer Management, Business Banking, Money Movement, Alerts, and Documents — are documented in the API reference but not yet exposed as MCP tools. New tools will be added as the beta expands; check this guide and release notes for updates.
Related Guides
- Overview — What the MCP Server is and who should use it
- Installation — Add the MCP server in your IDE
- Quick Start — Connect and run your first tool call