Main menu
Introduction

Accounts

Update contact info

Money Movement

Disclosures

Banking Images

Authentication

Alerts

Legacy Authentication

Reset Password

E-Statements

Experience Group

Banking

Customer Information

E-Statement Reports

.png)
Product Overview
The Experience Groups API features a set of services that allows an FI to create static experience groups and add, remove and replace
participants in those newly created or existing groups.
Value
The Experience Groups API enables customers to:
- Programmatically manage groups and participants in groups without having to log into the Admin Platform
What is Supported
The Experience Groups API supports the following use cases:
- Create, delete and update static experience groups
- Upload a file containing participants for add, remove or replace in those groups
- View lists of jobs (a job is what is created when an upload occurs)
- View details on a specific job using its ID
- View the latest job
- View errors for a job
Additional Product Details
This is the first version of the Experience Groups API.
Roles and Requirements
Required Roles & Permissions
In order for a customer to access the Experience Groups API, you will need a user with one of the following scopes:
Scope | Permissions |
---|---|
groups:write | A user with this scope may call the create, update and delete of groups and upload participants APIs. |
groups:read | A user with this scope may call the read jobs and job errors APIs. |
System Requirements & Configurations
The Experience Groups API must be accessed through a gateway managed by the Candescent Enterprise Platform team. It uses a v2 authentication token and requires the token to be generated.