List audit events (v2.0.0) — FrankieOne

List all audit events with filtering.

Headers

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

afterTimestampstringOptional

Filter the Audit Events after the given filter based on the Event ‘timestamp’ value

beforeTimestampstringOptional

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: APIPORTALONESDKSYSTEM

sortenumOptional

Order of the sort fields will be sorted upon

Allowed values: ascdesc

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

requestIdstringOptional

The unique request ID for the API call made.

metaobjectOptional

Meta information about the request and response that will be returned during a list operation

eventslist of objectsOptional

List of audit events matching the query.

1 curl https://api.uat.frankie.one/v2/audit \ 2 -H "X-Frankie-CustomerID: 12345678-1234-1234-1234-123456789012" \ 3 -H "X-Frankie-CustomerChildID: 87654321-4321-4321-4321-210987654321" \ 4 -H "api_key: <apiKey>"

1 { 2 "requestId": "01HN9XHZN6MGXM9JXG50K59Q85", 3 "meta": { 4 "page": 1, 5 "total": 1, 6 "limit": 1, 7 "count": 1, 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": "ENTITY_CREATE", 20 "timestamp": "2020-01-01T00:00:00Z", 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": "objectId", 29 "objectType": "ADDRESS", 30 "entityId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 31 "batchId": "batchId", 32 "serviceProfileId": "serviceProfileId", 33 "serviceName": "kyc", 34 "status": "UNCHECKED", 35 "workflowExecutionId": "workflowExecutionId", 36 "workflowName": "safe_harbour_1+1", 37 "workflowVersion": "v23", 38 "stepResultId": "stepResultId", 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 "supplementaryData": { 49 "type": "ORG_DATA_FETCH_CONNECTOR", 50 "connectorConfiguration": [ 51 { 52 "configurationKey": "configurationKey", 53 "description": "description", 54 "value": "value" 55 } 56 ], 57 "connectorDriverName": "supplementaryData", 58 "connectorName": "supplementaryData", 59 "errors": [ 60 { 61 "code": "code", 62 "description": "description", 63 "location": "location" 64 } 65 ], 66 "origin": { 67 "entityId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 68 "entityType": "INDIVIDUAL", 69 "details": [ 70 { 71 "code": "code", 72 "description": "description" 73 } 74 ] 75 }, 76 "resultSummary": [ 77 { 78 "sourceNormalized": "sourceNormalized", 79 "objectId": "objectId", 80 "objectType": "objectType", 81 "result": "result", 82 "notes": { 83 "key": { 84 "type": "type", 85 "value": "value" 86 } 87 } 88 } 89 ], 90 "validationIssues": [ 91 { 92 "code": "code", 93 "description": "description", 94 "location": "location" 95 } 96 ] 97 } 98 } 99 ] 100 }

1	curl https://api.uat.frankie.one/v2/audit \
2	-H "X-Frankie-CustomerID: 12345678-1234-1234-1234-123456789012" \
3	-H "X-Frankie-CustomerChildID: 87654321-4321-4321-4321-210987654321" \
4	-H "api_key: <apiKey>"

1	{
2	"requestId": "01HN9XHZN6MGXM9JXG50K59Q85",
3	"meta": {
4	"page": 1,
5	"total": 1,
6	"limit": 1,
7	"count": 1,
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": "ENTITY_CREATE",
20	"timestamp": "2020-01-01T00:00:00Z",
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": "objectId",
29	"objectType": "ADDRESS",
30	"entityId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
31	"batchId": "batchId",
32	"serviceProfileId": "serviceProfileId",
33	"serviceName": "kyc",
34	"status": "UNCHECKED",
35	"workflowExecutionId": "workflowExecutionId",
36	"workflowName": "safe_harbour_1+1",
37	"workflowVersion": "v23",
38	"stepResultId": "stepResultId",
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	"supplementaryData": {
49	"type": "ORG_DATA_FETCH_CONNECTOR",
50	"connectorConfiguration": [
51	{
52	"configurationKey": "configurationKey",
53	"description": "description",
54	"value": "value"
55	}
56	],
57	"connectorDriverName": "supplementaryData",
58	"connectorName": "supplementaryData",
59	"errors": [
60	{
61	"code": "code",
62	"description": "description",
63	"location": "location"
64	}
65	],
66	"origin": {
67	"entityId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
68	"entityType": "INDIVIDUAL",
69	"details": [
70	{
71	"code": "code",
72	"description": "description"
73	}
74	]
75	},
76	"resultSummary": [
77	{
78	"sourceNormalized": "sourceNormalized",
79	"objectId": "objectId",
80	"objectType": "objectType",
81	"result": "result",
82	"notes": {
83	"key": {
84	"type": "type",
85	"value": "value"
86	}
87	}
88	}
89	],
90	"validationIssues": [
91	{
92	"code": "code",
93	"description": "description",
94	"location": "location"
95	}
96	]
97	}
98	}
99	]
100	}