List audit events

1 curl -G https://api.uat.frankie.one/v2/audit \ 2 -H "api_key: <apiKey>" \ 3 --data-urlencode "workflowNames=KYC Onboarding" \ 4 --data-urlencode "workflowNames=Transaction Monitoring" \ 5 -d workflowRiskLevels=LOW \ 6 -d workflowRiskLevels=HIGH \ 7 --data-urlencode sources=user@username.com \ 8 --data-urlencode "sources=FrankieOne System" \ 9 --data-urlencode "sources=Experian Connector" \ 10 -d sortFields=timestamp \ 11 -d page=2 \ 12 -d limit=20

1 { 2 "requestId": "01HN9XHZN6MGXM9JXG50K59Q85", 3 "meta": { 4 "page": 42, 5 "total": 42, 6 "limit": 42, 7 "count": 42, 8 "sort": "asc", 9 "sortFields": [ 10 "createdAt" 11 ] 12 }, 13 "events": [ 14 { 15 "eventId": "123e4567-e89b-12d3-a456-426614174000", 16 "schemaVersion": 2, 17 "level": 2, 18 "requestId": "01HN9XHZN6MGXM9JXG50K59Q85", 19 "type": "CUSTOMER_SETUP", 20 "timestamp": "2020-01-01T00:00:00.000Z", 21 "source": "FrankieOne System", 22 "description": "Executing Vendor Check for Entity", 23 "channel": "API", 24 "eventStatus": "SUCCESS", 25 "elapsedTimeInMilliSeconds": 2, 26 "functionName": "executeVendorCheck", 27 "descriptionDetails": "A New Entity has been created with the following attributes:\n - Name\n - Address\n", 28 "objectId": "foo", 29 "objectType": "ADDRESS", 30 "entityId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 31 "batchId": "foo", 32 "serviceProfileId": "foo", 33 "serviceName": "kyc", 34 "status": "UNCHECKED", 35 "workflowExecutionId": "foo", 36 "workflowName": "safe_harbour_1+1", 37 "workflowVersion": "v23", 38 "stepResultId": "foo", 39 "stepName": "kyc-equifax", 40 "stepVersion": "v2.0.0", 41 "riskScore": 10, 42 "riskLevel": "UNKNOWN", 43 "entityType": "INDIVIDUAL", 44 "userComment": { 45 "commentId": "55fc5d54-46f7-49c8-bf78-e07ec79cd6e7", 46 "text": "Update after speaking to customer over phone directly" 47 }, 48 "lifecyclePhase": "OTHER", 49 "supplementaryData": { 50 "type": "RISK_ASSESSMENT", 51 "errors": [ 52 { 53 "code": "foo", 54 "description": "foo", 55 "location": "foo" 56 } 57 ], 58 "origin": { 59 "entityId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 60 "entityType": "INDIVIDUAL", 61 "details": [ 62 { 63 "code": "foo", 64 "description": "foo" 65 } 66 ] 67 }, 68 "previousRisk": { 69 "riskScore": 42, 70 "riskLevel": "UNKNOWN" 71 }, 72 "risk": { 73 "level": "foo", 74 "contributedScore": 42, 75 "overallScore": 42, 76 "factors": [ 77 { 78 "factor": "foo", 79 "score": 42, 80 "value": "foo" 81 } 82 ] 83 } 84 } 85 } 86 ] 87 }

List all audit events with filtering.

Query parameters

entityIdstringOptional

Entity ID

workflowNameslist of stringsOptional

List of Workflow Names to filter the audit events upon

workflowRiskLevelslist of stringsOptional

List of workflow risk levels to filter the audit events upon

sourceslist of stringsOptional

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

channelslist of enumsOptional

List of Channels to filter the audit events upon

Allowed values:

sortenumOptional

Order of the sort fields will be sorted upon

Allowed values:

sortFieldslist of enumsOptional

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

Allowed values:

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

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.

Headers

Query parameters

Response

Errors