Skip to main content

API Categories Overview

The Candescent Digital Banking Platform provides a comprehensive suite of APIs organized into logical categories. This guide provides an overview of each API category, helping you understand the available capabilities and navigate to detailed documentation.

At a Glance​

CategoryDescriptionPrimary Use Cases
AuthenticationOAuth token services supporting legacy v1 and current v2 flowsCreate, refresh, and revoke access tokens
Customer ManagementRegistration state and access management, user profile and identity, and contact infoManage registration, password resets, account unlocks, user profiles, and contact updates
Core BankingAccount data, transactions, activities, and banking imagesRetrieve balances, account details, transaction history, user activity events, and check or statement images
Business BankingBusiness onboarding and registration, profile overview, and entitlementsManage business onboarding, registration status, profiles, and access control
Money MovementTransfer recipients and payment executionManage recipients and perform one‑time or scheduled transfers
Alerts And NotificationsAlert types, templates, preferences, notification channels, history and eventsConfigure, manage, and deliver alerts while controlling notification settings
Documents And PreferencesInstitutional and user disclosures and electronic StatementsManage disclosure creation, updates, and status and enable paperless documents
Customer CampaignsExperience groups, jobs, promotions, and audience targetingSegment users, upload cohorts, manage promotions, and track job execution
MXMX-powered users, data, and embedded widgetsMX user journeys, enable account aggregation, and embedded financial widgets

Authentication​

Authentication APIs provide secure OAuth-based access to all Candescent services.

Capabilities​

  • 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

When to Use​

  • Authenticate before calling any protected API
  • Implement login and session management
  • Secure third‑party or server‑to‑server integrations

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​

  • 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

When to Use​

  • Register new digital banking users
  • Display or update customer profiles
  • Support password reset and recovery flows
  • Retrieve available MFA contact methods

Core Banking​

Core Banking APIs provide access to customer financial data including accounts, transactions, banking activities, and banking images.

Capabilities​

  • 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

When to Use​

  • Display account summaries and balances
  • Show transaction history
  • Provide check, deposit, or statement images
  • Build account and activity dashboards

Business Banking​

Business Banking APIs support onboarding and management of business customers and users.

Capabilities​

  • 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

When to Use​

  • Onboard new business customers
  • Track business registration status
  • Enforce business user permissions and limits
  • Integrate business‑specific banking workflows

Money Movement​

Money Movement APIs manage recipients and execute transfers.

Capabilities​

  • Recipients
    • Create, validate, update, and delete payees
  • Transfers
    • One‑time and scheduled recurring transfers
    • Support internal, loan, and recipient transfers

When to Use​

  • Build money transfer functionality
  • Manage payees and recipients
  • Schedule recurring or future‑dated payments
  • Support P2P or internal transfers

Alerts And Notifications​

Alerts and Notifications APIs define types, deliver, and manage customer notifications across channels.

Capabilities​

  • 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

When to Use​

  • Configure which alerts customers can receive
  • Trigger alerts for account or transaction events
  • Allow users to manage alert preferences
  • Track alert delivery and history

Documents And Preferences​

Documents and Preferences APIs manage disclosures, consent, and document delivery.

Capabilities​

  • 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

When to Use​

  • Present and track disclosure acceptance
  • Enable paperless statement enrollment
  • Ensure disclosure and regulatory compliance
  • Build digital consent workflows

Customer Campaigns​

Customer Campaigns APIs enable user segmentation for marketing and feature targeting.

Capabilities​

  • 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

When to Use​

  • Segment customers for marketing campaigns
  • Control feature rollouts or experiments
  • Perform A/B testing
  • Deliver targeted promotions

MX​

MX APIs integrate Candescent with MX Core Services for aggregation and financial insights.

Capabilities​

  • Account aggregation and enhanced transaction data
  • MX user and data access via gateway
  • Transaction log retrieval
  • Secure SSO URL generation for widgets

When to Use​

  • Aggregate external financial accounts
  • Provide budgeting and financial insights
  • Embed MX PFM widgets
  • Enable account verification and enrichment

Next Steps​

  1. Quick Start Guide - Make your first API call
  2. Authentication Guide - Set up API access
  3. Error Codes Reference - Handle API errors
  4. API Reference - Complete endpoint documentation