Transaction and Activity Monitoring V2 API - PreviewIndividual Activities

Get Individual Activities

Get a list of activities for an individual.

Path parameters

entityIdstringRequired
Unique identifier for an entity

Headers

api_keystringRequired
api_keystringRequired
Your API key provided by FrankieOne
X-Frankie-CustomerIDstringRequired
Your Customer ID provided by FrankieOne
X-Frankie-CustomerChildIDstringOptional
Your Customer Child ID provided by FrankieOne
X-Frankie-ChannelstringOptional

Open string that can be used to define the “channel” the request comes in from. It can potentially be used in routing and risk calculations upon request. Default values that can be used are: api portal smartui Any alphanumeric string is supported though. Anything over 64 characters will be truncated.

X-Frankie-UsernamestringOptional
Username provided by API caller

Query parameters

activityTypeslist of enumsOptional
Query parameter to filter activities by types
processResultIdstringOptional
Query parameter to filter activity results by process result ID
activityResultClasseslist of enumsOptional
Query parameter to filter results by classes
Allowed values:
sortFieldenumOptionalDefaults to ACTIVITY_AT
Query parameter to determine which fields specific field to sort by.
Allowed values:
sortenumOptionalDefaults to DESC

The order in which your results will display.

This is to be used in conjunction with sortField.

If there are multiple matches for the same value, the results will be sorted by the primary identifier (e.g. activityId).

Allowed values:
limitintegerOptional>=1Defaults to 20
Query parameter to limit the number of records returned
pageintegerOptionalDefaults to 1
Query parameter to paginate through returned items
statusenumOptional
Query parameter to filter activities and evaluations by manual status
Allowed values:
afterActivityAtstringOptionalformat: "date-time"
Query parameter to filter records after a specific activity timestamp. Timestamp values must be in UTC ISO8601 format.
beforeActivityAtstringOptionalformat: "date-time"
Query parameter to filter records that occurred before a specific activity timestamp. Timestamp values must be in UTC ISO8601 format.

Response

OK
activitieslist of objects
requestIdstring
The unique request identifier for the API call made.
metaobject
Meta information about the request and response

Errors