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 events in batch
To gain access a user will need to following scopes, banking-activites:read and account:read in the body.
ENDPOINTS
post
/v1/banking-activities
Header parameters
Collapse
Accept-Encoding
string
no
The server supports gzip compression. It is recommended to always pass this header to get compressed response faster.
Content-Type
string
no
The data format the client expects to receive in the response. Currently the only supported value `application/json`.
transactionId
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. For example - `123e4567-e89b-12d3-a456-426655440000`
Authorization
string
required
Authorization token issued for the client. For example - `Bearer 8a60b1b3-0c36-4a5f-8c15-a5e13f62f489`
Body parameters
Collapse
{"startTime":"2019-08-24T14:15:22Z","endTime":"2019-08-24T14:15:22Z","pageSize":200,"eventIds":["mfaChallenge","mfaEnrollment"],"userType":"retail","userIdType":"loginId","userId":"bbaadmin2","requestedAttributes":["ReqCtx_appId","ReqCtx_ipAddress","ReqCtx_locale","ReqCtx_loginId","ReqCtx_offeringId","ReqCtx_onBehalfOf","ReqCtx_region","ReqCtx_requestURI","ReqCtx_sessionId","ReqCtx_userProduct","ReqCtx_userType","cdiChallenged","cdiMode","challengeStatus","challengeType","invalidAttempts","passcodeSent","reason","source","step"],"additionalFilters":{"condition":"or","filters":[{"attributeId":"ReqCtx_appId","criteria":"equals","value":"USP"}],"subFilter":{"condition":"and","filters":[{"attributeId":"source","criteria":"equals","value":"web"}]}},"nextPageToken":"00f411a264961a7ec59e82999fb6375f"}
Responses
Collapse
200
Successful response with bankingActivities in body
Response Body
{"bankingActivities":[{"timeStamp":"2020-02-27T08:07:16.521-08:00","eventId":"mfaChallenge","guid":"d528a8921a37c13ga1234","ReqCtx_appId":"USP","ReqCtx_ipAddress":"165.225.106.120","ReqCtx_locale":"en_US","ReqCtx_loginId":"bbaadmin2","ReqCtx_offeringId":"USPServer","ReqCtx_onBehalfOf":14,"ReqCtx_region":"qa","ReqCtx_requestURI":"/usp-core/app/mfa","ReqCtx_sessionId":"7123f1be7bcd4bd2a726a21cf563b5a7","ReqCtx_userProduct":"USP","ReqCtx_userType":"SECONDARY_ADMIN","cdiChallenged":"No","cdiMode":"N/A","challengeStatus":"N/A","challengeType":"N/A","invalidAttempts":0,"passcodeSent":"Yes","reason":"mfa","source":"Web","step":"Challenge presented"}],"nextPageToken":"e5a164f1441722fef32ecb70605ff751"}
204
The query was processed successfully but yielded no banking activity bankingActivities
Response Body
null
400
Bad request sent
Response Body
{"errorCode":"string","errorMessage":"string"}
500
Internal Server Error
Response Body
{"errorCode":"string","errorMessage":"string"}
CURL REQUEST
curl -X 'POST' \
'https://api.candescent.com/digitalbanking/data-apis/v1/banking-activities' \
-H 'authorization: Bearer 8a60b1b3-0c36-4a5f-8c15-a5e13f62f489' \
-H 'transactionid: 123e4567-e89b-12d3-a456-426655440000' \
-H 'content-type: application/json' \
-H 'accept-encoding: gzip' \
-H 'accept: application/json' \
-d '{
"startTime": "2020-04-14T19:20:05.216Z",
"endTime": "2020-04-14T20:22:05.216Z"
}';RESPONSE
{"bankingActivities":[{"timeStamp":"2020-02-27T08:07:16.521-08:00","eventId":"mfaChallenge","guid":"d528a8921a37c13ga1234","ReqCtx_appId":"USP","ReqCtx_ipAddress":"165.225.106.120","ReqCtx_locale":"en_US","ReqCtx_loginId":"bbaadmin2","ReqCtx_offeringId":"USPServer","ReqCtx_onBehalfOf":14,"ReqCtx_region":"qa","ReqCtx_requestURI":"/usp-core/app/mfa","ReqCtx_sessionId":"7123f1be7bcd4bd2a726a21cf563b5a7","ReqCtx_userProduct":"USP","ReqCtx_userType":"SECONDARY_ADMIN","cdiChallenged":"No","cdiMode":"N/A","challengeStatus":"N/A","challengeType":"N/A","invalidAttempts":0,"passcodeSent":"Yes","reason":"mfa","source":"Web","step":"Challenge presented"}],"nextPageToken":"e5a164f1441722fef32ecb70605ff751"}
null
{"errorCode":"string","errorMessage":"string"}
{"errorCode":"string","errorMessage":"string"}
