Version: 1.4.0

Candescent DI API

Welcome to the Candescent Digital Insight API documentation. This comprehensive API platform enables financial institutions, Marketplace Partners, and developers to build powerful digital banking experiences.

Getting Started

New to the Candescent API? Start here:

• Quick Start Guide - Make your first API call in minutes
• API Categories Overview - Explore all available API categories
• Error Codes Reference - Handle errors effectively

API Categories

Category	Description
Authentication	OAuth token APIs (legacy v1 and current v2)
Customer Management	Registration and access, profile and status, and contact info
Core Banking	Accounts, transactions, banking activities, and banking images
Business Banking	Business registration, profile, and entitlements
Money Movement	Recipients and transfers
Alerts And Notifications	System and institution alerts, templates, institution and user preferences, notification channels, and history and events
Documents And Preferences	Institution and user disclosures, and electronic statements
Customer Campaigns	Experience groups, jobs, promotions suite, and audience
MX	MX users, data, and widgets

Base URLs

Environment	Base URL
Stage	https://api.candescent.com/digitalbanking/stage
Production	https://api.candescent.com/digitalbanking

Note: This documentation primarily references the Stage environment for examples.

Authentication Overview

Candescent APIs use OAuth 2.0 with JWT Bearer tokens. Follow these steps:

Step 1: Obtain Client Credentials

Get your Client ID and Client Secret from the Candescent Developer Console.

Step 2: Generate an Access Token

Bash

curl -X POST 'https://api.candescent.com/digitalbanking/stage/oauth2/v1/token' \
  -H 'Authorization: Basic <BASE64_ENCODED(CLIENT_ID:CLIENT_SECRET)>' \
  -H 'Content-Type: application/x-www-form-urlencoded' \
  -H 'transactionid: <YOUR_UNIQUE_UUID>' \
  -H 'institutionId: <YOUR_INSTITUTION_ID>' \
  -d 'grant_type=client_credentials'

Step 3: Make Authenticated Requests

Include the token in the Authorization header:

Bash

curl 'https://api.candescent.com/digitalbanking/stage/accounts/v1/accounts' \
  -H 'Authorization: Bearer <YOUR_ACCESS_TOKEN>' \
  -H 'institutionId: <YOUR_INSTITUTION_ID>' \
  -H 'transactionid: <YOUR_UNIQUE_UUID>'

Tip: Access tokens expire in ~1 hour. Implement token refresh logic for uninterrupted access.

For detailed authentication flows, see the Authentication API Reference.

Authentication

HTTP: Bearer Auth

Bearer {ACCESS_TOKEN}

Security Scheme Type:	http
HTTP Authorization Scheme:	bearer