Skip to main content

Search Banking Activities

Loading...
API endpoint path: /data-apis/v1/banking-activities

Searches and returns a page of banking activity records for the institution. The service scans institution-scoped activity data and returns matching banking activity records in batches, supporting pagination and fine-grained filtering across users, events, and request context attributes.

The request body must specify a time window using startTime and endTime. All requests are validated against institution context, input rules, and service-configured limits before execution.

Use this endpoint to:

  • Retrieve banking activity events for an institution within a specific time range.
  • Page through large result sets using pageSize and nextPageToken.
  • Scope activity results to specific users by providing userId with a required userIdType.
  • Filter activity events by event identifiers, event type, user type, and other request attributes.
  • Apply advanced, column-level filtering using logical AND / OR groupings via additionalFilters.
  • Limit returned data to specific attributes using requestedAttributes to reduce response size.
  • Continue a previously started query using an opaque nextPageToken.

Behavior and capabilities:

  • The startTime must be strictly earlier than endTime, and the time window must fall within the service’s configurable maximum lookback period (93 days).
  • All filters, identifiers, tokens, and attribute names are validated according to service rules, including printable-ASCII enforcement where applicable.
  • Results are paginated, with pageSize values limited to a configurable maximum (1000 by default).
  • If a query completes successfully but matches no records, the service responds with HTTP 204 and an empty body.
  • Responses are sent with gzip content coding.

Request​

Responses​

Success