Introduction
Accounts
Update contact info
Money Movement
Disclosures
Banking Images
Authentication
Alerts
Banking Activity
Unlock User
Legacy Authentication
Reset Password
Experience Group
Customer Information
Transactions
E-Statement Reports
.png)
Get Subscriptions by Fi
Api to get subscriptions by FI. This service uses a legacy authentication token.
ENDPOINTS
get
/subscriptions/v1/fis/{di_fiid}/subscriptions
Header parameters
Collapse
Authorization
string
required
Standard OAuth 2.0 access tokenA string composed of `Bearer` + `(space)` + `{token}`; example `Bearer rvYKAItOGiMQy1yOHdUDAHWp2HG1`
User-Agent
string
no
Identifies the application and the platform making the request.The expected format is `{Appname}/{Appversion}[/{DeviceID}][;{Platform User-Agent}]` e.g. iPhone/1.0/abc12345;Nokia3110
originating_ip
string
no
The IP address of the device making the request for authentication. If not provided the IP address logged will be the IP address extracted from the HTTP request. Note: this should be the originating device, rather than the client making the request e.g. if a mobile device is used the ip address should be that of the mobile device, rather than a back end service
di_tid
string
required
Unique id used to identify the request. The id allows the request to be traced through the entire request and reponse flow. The expected id is a UUID, in the canonical form e.g 123e4567-e89b-12d3-a456-426655440000
Body parameters
Collapse
Query parameters
Collapse
filterOutSubs
string
no
Its boolean type, when its true - subscription that is already processed during the given day will not be returned in the response
userToken
string
no
The user identifier of the last subscription in the previous list retrieved. If this is not specified, the calling application will receive the first 'limit' subscriptions in the list as response.
limit
string
no
The number of subscriptions to be retrieved as response. The default value for this query parameter is 30
eventType
string
no
The event type which identifies the subscription
Path parameters
Collapse
di_fiid
string
required
Identifies the Financial Institution
Responses
Collapse
CURL REQUEST
curl -X 'GET' \
'https://api.candescent.com/digitalbanking/subscriptions/v1/fis/{di_fiid}/subscriptions' \
-H 'di_tid: SOME_STRING_VALUE' \
-H 'originating_ip: SOME_STRING_VALUE' \
-H 'user-agent: SOME_STRING_VALUE' \
-H 'authorization: SOME_STRING_VALUE' \
-H 'accept: application/json' \ RESPONSE
