TypeScript SDK
The TypeScript Server SDK (@cdx-forge/di-typescript-sdk) is a Node.js client for the Candescent Digital Insight APIs.
What the TypeScript SDK does
@cdx-forge/di-typescript-sdk lets you call Candescent DI REST APIs from Node.js with a single-typed client instead of hand-written HTTP requests.
- Wraps every DI API operation — accounts, customers, authentication, business banking, money movement, alerts, and more through
CandescentClientservice-area properties - Handles OAuth for you — obtains, caches, and refreshes tokens; injects
Authorizationheaders on each request - Stays type-safe — request and response models are generated from the OpenAPI spec, so your editor and compiler catch mistakes before runtime
- Manages API complexity — V1/V2 OAuth routing, XML token responses, pagination, retries, and typed errors are built in
Use it in integration services, BFFs, batch jobs, Lambdas, and any server-side code that talks to Candescent on the backend.
Choose the TypeScript SDK when you need:
| Capability | Description |
|---|---|
CandescentClient | One typed entry point for all DI API service areas |
| Automatic OAuth | Client-credentials flow with token cache and refresh (no manual Authorization headers) |
| Typed models | Request and response types generated from OpenAPI |
PageIterator | Async iteration across paginated list endpoints |
| Typed errors | ApiError, AuthenticationError, NotFoundError, RateLimitError, and more |
| Built-in retries | Exponential backoff on transient 408, 429, and 5xx responses |
| Standalone operations | Per-operation imports via @cdx-forge/di-typescript-sdk/operations for Lambda and scripts |
Next steps
- Installation — install the package and run your first API call
- Quick Start — authentication, accounts, business banking, and standalone operations
- SDK Reference — full client API, service areas, and exports
- Examples — clone the examples repo and run scripts for every API area