Quick Start

Get up and running with the Candescent API within minutes.

Prerequisites

Before you begin, you'll need access to the Candescent Developer Console to obtain your API credentials.

For Financial Institution Developers

1. Request access to the Developer Console through your FI administrator.
2. Your FI admin or Candescent Support will grant access to the console.
3. Once approved, log in to the Developer Console to obtain your credentials.

Step 1: Obtain Your API Credentials

1. Log in to the Candescent Developer Console.
2. Navigate to your application settings.
3. Locate your Shared Key and Secret Key.
4. Copy and store these credentials securely.

warning

Never share your Secret Key or commit it to version control. Use environment variables to store sensitive credentials.

Step 2: Obtain an Access Token

Candescent APIs use OAuth 2.0 for authentication. Exchange your Shared Key and Secret Key for an access token.

note

OAuth 2.0 token requests use the standard parameter names client_id and client_secret (your Shared Key and Secret Key map to those values—for example in the request body or HTTP Basic Authentication).

important

For server-to-server API calls, you must use grant_type=client_credentials in your token request. This ensures the generated access token has the correct permissions for backend integrations.

See the Create Token API for complete request and response details and code examples.

tip

Access tokens typically expire after one hour. Implement token refresh logic in your application to maintain uninterrupted access.

Step 3: Make Your First API Request

Use the access token to make authenticated API calls. Include the token in the Authorization header with the Bearer prefix, along with the required headers listed below.

Try the List Accounts API to retrieve account information for a customer.

Step 4: Explore the API

Now that you've made your first successful request, explore our API documentation:

• Authentication API - Token management and OAuth flows
• Accounts API - Account information and balances
• Transfers API - Account transfer, loan payments, recipient, scheduled transfers
• User Alert Preferences API - User notification preferences

Environment URLs

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

note

Start with the stage environment for development and testing. Contact your Candescent representative for production access.

Need Help?

• Review the OIDC Integration Overview for SSO implementation.
• Visit the API Reference for complete endpoint documentation.
• Contact support at [email protected].