Banking Activity

API - V 2.5

Download Swagger Spec

Introduction

The Banking Activity API provides a robust set of query capabilities against the Candescent Digital Banking activity logging data stores. Generating timely and accurate reports of user activity in banking systems is a mission critical application. Everything from troubleshooting and fraud detection to customer service and marketing relies on the ability to query the activity history of the system and return meaningful results.

Value

The Banking Activity API provides an API access point for your activity data, allowing you to automate the consumption of that data in any way you see fit. Daily, hourly, or near real-time will be supported based on your needs. Powerful queries are made easy with a clearly defined set of parameters that can be mixed and matched for a variety of use cases.

What is supported?

The Banking Activity API technical documentation in the API Specs section fully describes the endpoints, header values, parameters and responses. Below is an overview of the API capabilities:The technical documentation in the API specs sectionfully describes the endpoints, header values, parameters and responses. The APIuses th method for activity record retrieval.

NOTE: The API can be used to build reporting tools for financial institution (FI) administrators and customer support teams, as well as for others authorized to have such access.

The API uses the POST method for activity record retrieval:

Retrieve all events for a single user at an FI over a given date range:

Specify a single user and date range
Retrieve all activity by that user within the dates queried

Query multiple events for a user at an FI for a given date range:

Specify a single user and one or more event types.
Retrieve all records matching the specified event types within the dates queried.

Query one event for a user at an FI for a given date range:

Specify a single user and one event type.
Retrieve all instances of that one event type for the specified user within the dates queried.

Query all events for an FI for a given range:

Specify all events, regardless of user, type, etc. and the date range.
Retrieve all customer or member events for the specified FI within the dates queried.

Query multiple events for an FI for a given date range:

Specify one or more event types and the date range.
Retrieve all instances of the specified event types within the dates queried.

Query 1 event for an FI for a given date range:

Specify a single event type and the date range.
Retrieve all instances of the event type within the dates queried.

Additional Product Details

Control Descriptions:
‍
(1-2) Start and end date for date range.
(3) Individual user ID or list of several users.
(4) Limit search to retail or business banking.
(5) For business banking, limit query to one or more companies.
(6) Selector for event types (event types are pre-defined by Candescent).
(7) Selector for query operators - AND, OR, NOT
(8) Multiple switches/selectors for filter attributes, - account type, event type, etc.

Status Codes

Status Code	Meaning
200	Report is available in body.
204	Query processed successfully but with no results.
400	Error in request
429	Too many requests
500	Internal Server Error

Headers

The Content-Type of the response will be application/json (although other types (e.g. XML) may be supported in future.

Body

The response body will contain a JSON document with the following properties.

Name	Description	Notes
queryReference	Allows retrieval of the next page of results from a previous query	Will only be provided if there are more results to be retrieved; otherwise, this value will be null
bankingActivities	The list of banking activity results	Between 0 and maxResults (Less than maxResults will be returned if unavailable or if server decides to limit results)

Getting Started

Candescent’s APIs support financial institutions worldwide. They can empower financial institutions and their partners to build valuable digital banking experiences.

It’s important to work with your Candescent representative to get officially onboarded to DevX for access to these APIs. Once onboarded, you’ll be able to implement your application, access shared and secret keys and begin testing the APIs.

After all the legal and compliance partnership agreements are in place, we'll set you up with your Authentication API client account. This will grant you access to a unique secret key that will be your ticket to the authentication API and staging and production environments.
‍
The service available through the Candescent Digital Banking Developer Portal provides a token for the grant type:

Client Credentials‍

Used for trusted server-side applications
Sending a request passes a key-and-secret pair assigned to your application‍
Since the token is issued in the context of a Financial Institution (FI) rather than a user, no end-user login is required
Response provides the Bearer Token to be used to call other DevEx APIs

Steps to getting started:

Sign up and/or Login in for authentication
‍
To make your first API request, you'll need toself-register by clicking the Sign Up button. Then, click the link in your welcomeemail to verify your emailaddress.
Review API documentation and request postman collections

Your Candescent representative will be able to email you the Postman collection for an API you are interested in. You may reach out directly or add the specific API to your favorites to alert your representative.
‍‍
Test APIs in Postman

In addition to the sample apps, a test drive environment is available to help you visualize the APIs. Using the JSONcollection and Postman, you’ll be able to see API requests working in action and view the information required to make them.

This will also allow you to experience actual API behavior prior to beginning your integration. For a deeper dive into Postman, view additional reference material here.