KYC V2 APIAudit

List audit events

List all audit events with filtering.

Headers

api_keystringRequired
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.

Query parameters

entityIdstringOptional
Entity ID
workflowNamesstringOptional
List of Workflow Names to filter the audit events upon
workflowRiskLevelsstringOptional
List of workflow risk levels to filter the audit events upon
sourcesstringOptional
List of Sources that the audit events will be filtered upon
requestIdstringOptional
Request Identifier to filter the audit events upon
afterTimestampstringOptionalformat: "date"
Filter the Audit Events after the given filter based on the Event 'timestamp' value
beforeTimestampstringOptionalformat: "date"
Filter the Audit Events before the given filter based on the Event 'timestamp' value
channelsenumOptional
List of Channels to filter the audit events upon
Allowed values:
sortenumOptional
Order of the sort fields will be sorted upon
Allowed values:
sortFields"timestamp"OptionalDefaults to timestamp
The list of sort fields that will be used in the query, the order of the sort fields will determine the order in which the items are sorted
pageintegerOptional
The page number that you want to retrieve for the list query
limitintegerOptional>=1Defaults to 20
Limit the number of items that will be returned as part of the request

Response

OK
requestIdstring or null
The unique request ID for the API call made.
metaobject or null
Meta information about the request and response that will be returned during a list operation
eventslist of objects or null
List of audit events matching the query.

Errors