Skip to main content

Banking Activities

The Banking Activities API provides search access to institution-scoped activity records, including authentication events, MFA actions, payment activity, audit events, and related operational activity. Results are returned in batches with pagination and flexible filtering across users, events, and request-context attributes.

End-user benefits

  • Retrieve activity events within a required startTime and endTime window (up to a 90‑day lookback).
  • Page through large result sets using pageSize and nextPageToken.
  • Scope activity results to retail or business users, companies, event identifiers, or attribute-level conditions without accessing raw log data.

Integration capabilities

  • Search activities using SearchCriteria request body; requires ISO 8601 startTime and endTime; startTime must be strictly earlier than endTime.
  • Filter results by eventIds, eventType (user or system), userType (retail or business), userId / userIdType, and companyId.
  • Apply advanced additionalFilters with AND/OR groupings across request-context attributes.
  • Reduce response payloads with requestedAttributes and continue queries using an opaque nextPageToken.
  • Returns matching bankingActivities records (gzip-encoded); responds with HTTP 204 when no records match.

Scopes

ScopeDescription
banking-activities:readRead banking activities

Required headers

HeaderDescription
AuthorizationBearer {token} (OAuth V2)
transactionIdUUID used to trace and correlate requests across services for debugging and logging.

Error codes (BAS_*)

CodeMessageHTTP Status Code
BAS_10001The given start date must be earlier than end Date.400
BAS_10002The given start date must be within last three months.400
BAS_10003BigTable connection failed.500
BAS_10004BigTable rows could not be read.500
BAS_10005Invalid arguments passed in the request; Failed to read HTTP message400
BAS_10006Http Message not readable400
BAS_10007NOT EQUAL and LIKE criterias not supported at this time.400
BAS_10008Additional filters condition and sub filter condition cannot be the same.400
BAS_10009Invalid UserType requested.400
BAS_10010Invalid UserIdType requested.400
BAS_10011UserIdType must be present if userId is given.400
BAS_10012Invalid EventType requested.400
BAS_10021BigTable Query is invalid.400
BAS_10022Row key is unexpectedly empty.400
BAS_10101Full authentication was not provided in the request.401 or 403
BAS_10102Authentication token sent in the request is invalid.401
BAS_10103The authentication provided does not authorize this request.400
BAS_10104The jwt token is invalid.401
BAS_10105Unauthorized access.400
BAS_10201Request should only contain printable ASCII characters400
BAS_10202transactionId header is too long400
BAS_10203One or more header values are invalid400
BAS_10204Invalid Request body400
BAS_10205One or more header values are too long400
BAS_10206nextPageToken is invalid400
BAS_10207Requested method type is invalid400
BAS_99999Internal server error500

Endpoints