The API would return the requested activity data matching some set of criteria that has been specified. (For example, "Give me login events for the past three days for user with Member ID 123456".)The user in this case is the customer of financial institution.
Returns a list of events in batchRequest:
- POST /data-apis/v1/banking-activities
Headers:
- Authorization: The bearer access token from the Authentication API
- TransactionId: A UUID string used as unique identifier for this token request
- Content-Type: application/json
Body:
- startTime: Format: yyyy-mm-ddThh:mm:ss.SSS±hh:mm - The minutes and seconds format should always be 00:00.000, 00:15.000, or 00:30.000 or 00:45.000. This is a required parameter.
- endTime: Format: yyyy-mm-ddThh:mm:ss.SSS±hh:mm - The minutes and seconds format should always be 00:00.000, 00:15.000, or 00:30.000 or 00:45.000. This is a required parameter.
- pageSize: Number of banking activity results expected. Default value is 500.
- userId: Login identifier or member identifier value based on the type
- userIdType: The type of userId provided: LoginId, MemberId
- eventIds: List of event ids to filter on
- additionalFilters: List of additional filters on results
- requestedAttributes: List of IDs of attributes to return in data set
- nextPageToken: Allows retrieval of next page of results for the same query. All the previous filter values needs to be sent for pagination to work properly. If specified, will allow continuation of a previous query
{
"startTime": "2021-12-01",
"endTime": "2022-03-02"
}
Example Code
Here's an excerpt from the Accounts service:
Returns a list of events in batch:
{
"nextPageToken": "MDU1MjZ8OTIyMzM3MDM5MTYyMzUxNjI4NXw5YjdhMGMzMy05MTFjLTExZWMtOGMwOC0wMDUwNTZhMDRlYTo",
"count": 1000,
"bankingActivities": [
{
"reqctx_canonicalid": "05500",
"reqctx_ipaddress": "165.225.60.124",
"eventid": "apiUse",
"reason": "N/A",
"productcode": "APX",
"reqctx_customertype": "N/A",
"reqctx_bcid": "05500",
"source": "Web",
"reqctx_locale": "en_US",
"glappid": "CIS",
"result": "Failure",
"reqctx_appid": "CIS",
"admintype": "FIAdmin",
"reqctx_offeringid": "ApigeeApp",
"reqctx_timezone": "America/Los_Angeles",
"timestamp": "2022-02-23T12:34:33.152-08:00",
"clientversion": "3.2.0",
"reqctx_usertype": "N/A",
"reqctx_tzoffset": "-0800",
"reqctx_userproduct": "API",
"reqctx_featurename": "API",
"reqctx_id": "3ced6b81-5ac4-4211-8b87-07e312465a91",
"reqctx_transid": "5409ad7a-cf18-4c4d-abb0-7772ce1e00b2",
"eventdate": "2022-02-23",
"reqctx_userid": "N/A",
"reqctx_bcindex": "26",
"apiname": "db-apx-minerva - QueryActivityEvents-v1",
"guid": "022de938-94e8-11ec-931f-005056a05f50",
"reqctx_useragent": "PostmanRuntime/7.28.4",
"eventtype": "Audit",
"reqctx_region": "prod",
"reqctx_sessionid": "5409ad7a-cf18-4c4d-abb0-7772ce1e00b2",
"reqctx_homeid": "05526"
}
]
}