Main menu

Introduction

Overview

Getting Started

Authentication

Use Cases & Examples
‍

Accounts

Gets accounts for the given institution customer.

get

Gets accounts for the given institution customer.

Gets the specified account for the given user.

get

Gets the specified account for the given user.

Update contact info

API to update contact info

put

API to update contact info

Money Movement

Creates a transfers

POST

Creates a transfers

Retrieves a list of recipients.

GET

Retrieves a list of recipients.

Creates/validates a recipient.

POST

Creates/validates a recipient.

Retrieves a single recipient.

GET

Retrieves a single recipient.

Deletes an existing recipient.

DELETE

Deletes an existing recipient.

Updates an existing recipient.

PUT

Updates an existing recipient.

Disclosures

Deletes a specific user disclosure previously accepted by the user. institutionUserDisclosureId field is optional and will be supported in future when user level disclosures have a GUID.

DELETE

Deletes a specific user disclosure previously accepted by the user. institutionUserDisclosureId field is optional and will be supported in future when user level disclosures have a GUID.

Updates a disclosure for Financial Institution.

PUT

Updates a disclosure for Financial Institution.

Creates a disclosure for Financial Institution.

POST

Creates a disclosure for Financial Institution.

Updates an existing user disclosure. institutionUserDisclosureId field is optional and will be supported in future when user level disclosures have a GUID.

PUT

Updates an existing user disclosure. institutionUserDisclosureId field is optional and will be supported in future when user level disclosures have a GUID.

Deletes a specific user disclosure previously accepted by the user.

DELETE

Deletes a specific user disclosure previously accepted by the user.

Gets all the disclosures accepted by a user.

GET

Gets all the disclosures accepted by a user.

Creates a user disclosure acceptance record for a specific disclosure.

POST

Creates a user disclosure acceptance record for a specific disclosure.

Updates an existing user disclosure.

PUT

Updates an existing user disclosure.

Gets all the disclosures for a Financial Institution.

GET

Gets all the disclosures for a Financial Institution.

Banking Images

Gets the specific image for an account

GET

Gets the specific image for an account

Gets various types of images for the given account.

GET

Gets various types of images for the given account.

Authentication

Get Token

POST

Get Token (Client credentials, password grant, refresh access token, authorization code grant)

Revoke Token

DELETE

Revoke access or refresh token

Checks

Retrive the status of checks

POST

Retrive the status of checks

Alerts

Fetch the institution/default templates by various filters

GET

Fetch the institution/default templates by various filters

Modify/Update the institution/default template

PUT

Modify/Update the institution/default template

Create the default/institution template

POST

Create the default/institution template

Delete institution/default Template By template ID

DELETE

Delete institution/default Template By template ID

To Fetch Alert Type resources based on multiple filters

GET

To Fetch Alert Type resources based on multiple filters

Update Alert Type for ExternalSystem / Institution

PUT

Update Alert Type for ExternalSystem / Institution

Create Alert Type for ExternalSystem / Institution

POST

Create Alert Type for ExternalSystem / Institution

Delete Alert Type for ExternalSystem / Institution

DELETE

Delete Alert Type for ExternalSystem / Institution

Getting FI Alert Type resources based on filters

GET

Getting FI Alert Type resources based on filters

update Alert type for Institution

PUT

update Alert type for Institution

Create Fi Alert type for channels

POST

Create Fi Alert type for channels

Delete Alert type for Institution

DELETE

Delete Alert type for Institution

Get all preferences opted by user ,if not found in alert-pref-service will be pulled Institution alert preference

GET

Get all preferences opted by user ,if not found in alert-pref-service will be pulled Institution alert preference

Create user alert preference for institution customer

POST

Create user alert preference for institution customer

Get alert preference by id

GET

Get alert preference by id

Update user alert preference for existing alert preference

PUT

Update user alert preference for existing alert preference

Delete user alert preference for existing alert preference

DELETE

Delete user alert preference for existing alert preference

Get all preferences opted by FI

GET

Get all preferences opted by FI

Create Fi alert preference

POST

Create Fi alert preference

Update Fi alert preference for earlier existing alert preference

PUT

Update Fi alert preference for earlier existing alert preference

Delete fi alert preference for earlier existing alert preference

DELETE

Delete fi alert preference for earlier existing alert preference

Fetch the Alert history by various parameters

GET

Fetch the Alert history by various parameters

Fetch the Alert history content by id / history summary id/ event id

GET

Fetch the Alert history content by id / history summary id/ event id

Publish Events

POST

Publish Events

Enqueue a user list to be uploaded to Promotion Suite

POST

Enqueue a user list to be uploaded to Promotion Suite

Get the user list upload status

GET

Get the user list upload status

Get Subscriptions by user

GET

Get Subscriptions by user

Get Subscriptions by Fi

GET

Get Subscriptions by Fi

Get Subscription

GET

Get Subscription

Update Subscription

PUT

Update Subscription

Create Subscription

POST

Create Subscription

Delete Subscription

DELETE

Delete Subscription

Send Event

POST

Send Event

Get Destinations

GET

Get Destinations

Update Destinations

PUT

Update Destinations

Create Destinations

POST

Create Destinations

Delete Destinations

DELETE

Delete Destinations

Delete Destination

DELETE

Delete Destination

Banking Activity

Returns a list of events in batch.

POST

Returns a list of events in batch.

Unlock User

Unlock the specified user

PUT

Unlock the specified user

Customer

API to register the fi customer

POST

API to register the fi customer

Legacy Authentication

Create Access Token

POST

Create Access Token

Reset Password

Fetch the contact methods for a given customer

GET

Fetch the contact methods for a given customer

Send a one-time passcode to a given customer for resetting their password

put

Send a one-time passcode to a given customer for resetting their password

E-Statements

to fetch disclosure information for the particular account id

get

API to update contact info

API to update the Statement Preferences

put

API to update contact info

Experience Group

API to delete group by id

delete

API to delete group by Id

API to update groups

put

API to update groups

API to get errors

get

API to get errors

API to update participants

put

Upload file to add, remove or replace users in a group

API to create group

post

API to create group

API to get job by Id

get

API to get job by Id

API to get groups

get

API to get groups

API to get jobs

get

API to get jobs

Banking

Get FI Customer

get

API to get customer information

Get Customer Accounts

get

API to get customer accounts

Customer Information

Fetches customer accounts

get

API to the customer accounts

Registers the FI Customer

get

API to register FI Customer

Fetches Customer Registration Information

get

API to Fetch Customer Registration Information

Transactions

Get transactions for given account

get

API to fetch transactions for given account

E-Statement Reports

Fetches Opt-In Data

get

API to fetch opt-in data

Explore Postman

Simplify and streamline building products with postman

Visit Postman.com

Already have Postman?

Visit our developer guides to learn more.

How to use Postman

Home

APIs

Experience Group

API - V 2.5

Download Swagger Spec

Create groups

Api to create groups

ENDPOINTS

post

/v3/groups

Header parameters

Collapse

Expand

transactionId

string

required

An ID that identifies this request. A unique identifier should be generated for each request made.

Body parameters

Collapse

Expand

No items found.

{"groupId":"482cf7f8-3e59-4ccf-a996-97c79fd50cb1","groupName":"some group name","groupDescription":"description - some group description"}

Query parameters

Collapse

Expand

No items found.

Path parameters

Collapse

Expand

No items found.

Responses

Collapse

Expand

200

Response Body

{"groupId":"string","groupName":"string","groupDescription":"string","groupType":"EXPERIENCE_GROUP","groupPlatform":"RETAIL_BANKING","groupLastUpdatedDateTime":"string","groupParticipantCount":0,"groupExperience":{"experienceName":"string","experienceId":"string","groupId":"string","default":true},"groupExperienceName":"string","groupStatus":"ACTIVE"}

400

Bad Request

Response Body

{"code":"string","message":"string"}

401

Unauthorized

Response Body

{"code":"string","message":"string"}

500

Internal Server Error

Response Body

{"code":"string","message":"string"}

CURL REQUEST

curl --request POST \
  --url https://api.candescent.com/digitalbanking/groups/v3/groups \
  --header 'accept: application/json' \
  --header 'content-type: application/json' \
  --data '{"groupName":"My new static group","groupDescription":"some description"}'

Get Response