Fetch entities that have had some form of transaction monitoring check completed.

Headers

apiKeystringRequired
X-Frankie-CustomerIDstringRequired
Your Customer ID provided by FrankieOne
X-Frankie-CustomerChildIDstringOptional
Your Customer Child ID provided by FrankieOne

Query parameters

entityIdstringOptional
Unique identifier of a FrankieOne entity
isActivebooleanOptional
A boolean value to whether we want to only fetch the alerts that have not been resolved
typesenumOptional
comma delimited list of EnumRiskResultType
Allowed values:
subtypesstringOptional
comma delimited list of strings representing the Subtypes
assignedTostringOptional
User identifier that will filter based on which alerts are assigned to
riskLevelsenumOptional
comma delimited list of strings representing the risk levels
Allowed values:
activityTypeenumOptional
comma delimited list of EnumActivityType
offsetintegerOptionalDefaults to 0
Number of items to offset by
limitintegerOptionalDefaults to 20
Limit to the Number of Results to return in the response payload
orderenumOptional
The order in which the records will be sorted in before returning in the response payload
Allowed values:
sortFieldenumOptional
Field that the entities will be sorted upon.
Allowed values:

Response

Response from the GET /entities endpoint

datalist of objects
List of Entities that have had a Transaction Monitoring check completed found from the query
metaobject

Errors