API Categories Overview
The Candescent Digital Banking Platform provides a comprehensive suite of APIs organized into logical categories. This guide outlines each API category, making it easier to understand their capabilities and access the detailed documentation.
At a Glance
| Category | Description | Primary Use Cases |
|---|---|---|
| Authentication | OAuth token services supporting legacy v1 and current v2 flows | Create, refresh, and revoke access tokens |
| Customer Management | Registration state and access management, user profile and identity, and contact information | Manage registration, password resets, account unlocks, user profiles, and contact updates |
| Core Banking | Account data, transactions, activities, and banking images | Retrieve balances, account details, transaction history, user activity events, and check or statement images |
| Business Banking | Business onboarding and registration, profile overview, and entitlements | Manage business onboarding, registration status, profiles, and access control |
| Money Movement | Transfer recipients and payment execution | Manage recipients and perform one‑time or scheduled transfers |
| Alerts And Notifications | Alert types, templates, preferences, notification channels, history and events | Configure, manage, and deliver alerts while controlling notification settings |
| Documents And Preferences | Institutional and user disclosures and electronic Statements | Manage disclosure creation, updates, and status and enable paperless documents |
| Customer Campaigns | Experience groups, jobs, promotions, and audience targeting | Segment users, upload cohorts, manage promotions, and track job execution |
| MX | Transparent passthrough proxy APIs to MX Platform, Real Time, Reporting, and SSO | Aggregate external financial accounts, synchronize core data in real time, process daily MX change files, and embed MX widgets with SSO |
Authentication
Authentication APIs provide secure OAuth-based access to all Candescent services.
| Capabilities | When to Use | Reference Links |
|---|---|---|
| OAuth 2.0 token issuance, refresh, and revocation Support for Client Credentials, Password, and Authorization Code grants Legacy OAuth V1 support for older endpoints User and institution‑scoped authentication | Authenticate before calling any protected API Implement login and session management Secure third‑party or server‑to‑server integrations | OAuth V1 OAuth V2 |
Token Versions
- V1: Legacy endpoints (Send Event, Destinations, Get FI Customer, Register User)
- V2: All modern APIs (Accounts, Alerts, Disclosures, Money Movement, Transactions)
Customer Management
Customer Management APIs handle digital banking customer identity and access.
| Capabilities | When to Use | Reference Links |
|---|---|---|
| Registration – Enroll customers into digital banking Access Management – Password reset via OTP – User unlock operations Profile Retrieval – Name, contact info, identifiers, status Contact Info – Manage MFA and notification destinations and postal address | Register new digital banking users Display or update customer profiles Support password reset and recovery flows Retrieve available MFA contact methods | Registration And Access Profile And Status Contact Info |
Core Banking
Core Banking APIs provide access to customer financial data including accounts, transactions, banking activities, and banking images.
| Capabilities | When to Use | Reference Links |
|---|---|---|
| Account Information: Retrieve account balances, status, and detailed attributes Transaction History: Access posted and pending transactions with date filtering Banking Activities: Query paged, filtered banking activity events (authentication, operational, and transaction-related) over a time range Banking Images: Download check images, deposit slips, and statement images linked to transactions Advanced Filtering: OData filtering by account category (DEPOSIT, LOAN, INVESTMENT) Cross‑Account Support: View linked and cross‑user accounts in a unified experience Balance Reconciliation: Support for running balances and transaction reconciliation Business Banking Context: Entity‑based account grouping for business users | Display account summaries and balances Show transaction history Provide check, deposit, or statement images Build account and activity dashboards | Accounts Transactions Banking Activities Images |
Business Banking
Business Banking APIs support onboarding and management of business customers and users.
| Capabilities | When to Use | Reference Links |
|---|---|---|
| Registration – Create and track business registrations – Query by registration ID or confirmation number Business Profile Management – Retrieve business details, users, and identifiers Entitlements & Limits – Retrieve business‑ and user‑level permissions – Enforce feature access and transaction limits Institution Configuration – Access FI‑specific business feature settings | Onboard new business customers Track business registration status Enforce business user permissions and limits Integrate business‑specific banking workflows | Registration Profile Entitlements |
Money Movement
Money Movement APIs manage recipients and execute transfers.
| Capabilities | When to Use | Reference Links |
|---|---|---|
| Recipients – Create, validate, update, and delete payees Transfers – One‑time and scheduled recurring transfers – Support internal, loan, and recipient transfers | Build money transfer functionality Manage payees and recipients Schedule recurring or future‑dated payments Support P2P or internal transfers | Recipients Transfers |
Alerts And Notifications
Alerts and Notifications APIs define types, deliver, and manage customer notifications across channels.
| Capabilities | When to Use | Reference Links |
|---|---|---|
| Alert Types – Define alert configuration (Low Balance, Large Transaction) – Configure institution‑level alert availability Templates – Create channel‑specific message templates – Support dynamic variable substitution Preferences – Manage user and institution alert preferences – Configure thresholds and delivery channels Notification Channels – Manage SMS, Email, Push, and Web destinations History and Events – Publish alert events – Retrieve alert history and delivery status | Configure which alerts customers can receive Trigger alerts for account or transaction events Allow users to manage alert preferences Track alert delivery and history | System Alerts Institution Alerts Templates Institution Preferences User Preferences Notification Channels History And Events |
Documents And Preferences
Documents and Preferences APIs manage disclosures, consent, and document delivery.
| Capabilities | When to Use | Reference Links |
|---|---|---|
| Institution Disclosures – Create and manage regulatory disclosures User Disclosures – Track user acceptance and enrollment status Electronic Statements – Manage electronic vs paper statement preferences – Support account‑ and user‑level enrollment | Present and track disclosure acceptance Enable paperless statement enrollment Ensure disclosure and regulatory compliance Build digital consent workflows | Institution Disclosures User Disclosures Electronic Statements |
Customer Campaigns
Customer Campaigns APIs enable user segmentation for marketing and feature targeting.
| Capabilities | When to Use | Reference Links |
|---|---|---|
| Experience Groups – Create and manage user cohorts – Bulk upload participants (ADD/ REMOVE/ REPLACE) Jobs – Monitor asynchronous batch operations Promotions – Upload and manage audiences for Promotion Suite Audience Management – Manage campaign user lists – Track upload processing and errors | Segment customers for marketing campaigns Control feature rollouts or experiments Perform A/B testing Deliver targeted promotions | Experience Groups Jobs Promotions Suite Audience |
MX
MX APIs integrate Candescent with MX Core Services through transparent gateway passthrough for Platform, Real Time, Reporting, and SSO.
| Capabilities | When to Use | Reference Links |
|---|---|---|
| Platform – Transparent passthrough to MX Platform APIs for aggregating and enhancing financial data across users, members, institutions, accounts, transactions, and statements – Unified access to external balances, transactions, and account context with data cleansing, categorization, and insights Real Time – Transparent passthrough for synchronous CRUD on users, members, accounts, transactions, and holdings – Push and synchronize institution core data with MX pipelines in real time Reporting – Transparent passthrough to retrieve daily MX change files by date, resource, and action – Self-describing Avro files with embedded schema metadata for batch ingestion SSO – Transparent passthrough for widget URLs and session authentication – Embed PFM and Financial Insights widgets via webview or iframe without exposing long-lived credentials | Platform – Aggregate external financial accounts and support end-to-end MX user lifecycle workflows – Access enhanced transaction data through the MX Platform pipeline Real Time – Push current balances, transactions, and holdings from core systems to MX-powered experiences – Keep user, member, and account data synchronized with MX in real time Reporting – Track platform-wide data changes without querying individual users – Enable operational reporting, reconciliation, and downstream analytics with daily change feeds SSO – Launch MX widgets (for example, Mini Budgets and other PFM experiences) in a webview or iframe – Authenticate users on the MX platform using SSO-based sessions and short-lived redirect URLs | Platform Real Time Reporting SSO |
Next Steps
- Quick Start Guide - Make your first API call
- Authentication Guide - Set up API access
- Error Codes Reference - Handle API errors
- API Reference - Complete endpoint documentation