Get a list of process results (v2.0.0) — FrankieOne

Get a list of process results for a given individual entity

Path parameters

entityIdstringRequired

Unique FrankieOne identifier for an entity

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.

X-Frankie-UsernamestringOptional

Username provided by API caller

Query parameters

profileNamestringOptional

The unique name of the service profile

createdAtBeforedatetimeOptional

Filter on the createdAt field, results returned are based on being before the value (inclusively)

createdAtAfterdatetimeOptional

Filter on the createdAt field, results returned are based on being after the value (inclusively)

updatedAtBeforedatetimeOptional

Filter on the updatedAt field, results returned are based on being before the value (inclusively)

updatedAtAfterdatetimeOptional

Filter on the updatedAt field, results returned are based on being before the value (inclusively)

stepNamesstringOptional

List of steps to include, separated by a comma.

stepTypesstringOptional

A list of stepTypes the Process Result is associated with

objectTypesstringOptional

List of objectTypes to filter upon

classesstringOptional

List of classes to filter results with Available values : KYC, ID, IDV, AML, FRAUDLIST, FRAUDCHECK, DEVICE, MOBILE, EMAIL, LOOKUP, CREATE, UPDATE, DELETE, MANUAL

systemStatusesstringOptional

List of systemStatus values to filter results with Available values : VALID, EXPIRED, STALE, MARKED_INVALID, MARKED_IGNORE

manualStatusesstringOptional

statesstringOptional

List of state values to filter results with Available values : IN_PROGRESS, COMPLETED, TIMEOUT, ERROR

resultsstringOptional

List of result value that the Process Result will be filtered with Available values : MATCH, PARTIAL_MATCH, INVALID_MATCH, NO_MATCH, CLEAR, HIT, BAD_DATA, CREATED, UPDATED, DELETED, FAIL

sortFieldsstringOptional

List of fields that the Process Results will be filtered with Available values : createdAt, updatedAt

sort"asc" or "desc"Optional

Order of the sort fields will be sorted upon

Allowed values: ascdesc

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

metaobjectOptional

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

requestIdstringOptional

The unique request ID for the API call made.

processResultslist of objectsOptional

1 curl -G https://api.uat.frankie.one/v2/individuals/entityId/results \ 2 -H "X-Frankie-CustomerID: 12345678-1234-1234-1234-123456789012" \ 3 -H "X-Frankie-CustomerChildID: 87654321-4321-4321-4321-210987654321" \ 4 -H "X-Frankie-Username: fred.flintstone@frankieone.com" \ 5 -H "api_key: <apiKey>" \ 6 --data-urlencode createdAtBefore=2024-02-29T02:15:04Z \ 7 --data-urlencode createdAtAfter=2024-02-29T02:15:04Z \ 8 --data-urlencode updatedAtBefore=2024-02-29T02:15:04Z \ 9 --data-urlencode updatedAtAfter=2024-02-29T02:15:04Z

1 { 2 "meta": { 3 "page": 1, 4 "total": 1, 5 "limit": 1, 6 "count": 1, 7 "sort": "asc", 8 "sortFields": [ 9 "createdAt" 10 ] 11 }, 12 "requestId": "01HN9XHZN6MGXM9JXG50K59Q85", 13 "processResults": [ 14 { 15 "processResultId": "processResultId", 16 "schemaVersion": 1, 17 "entityId": "entityId", 18 "requestId": "01HN9XHZN6MGXM9JXG50K59Q85", 19 "stepName": "stepName", 20 "stepType": "stepType", 21 "objectType": "objectType", 22 "objectId": "objectId", 23 "createdAt": "2024-01-15T09:30:00Z", 24 "updatedAt": "2024-01-15T09:30:00Z", 25 "groupId": "groupId", 26 "providerResult": { 27 "name": "name", 28 "source": "source", 29 "sourceNormalized": "sourceNormalized", 30 "reference": "reference", 31 "fuzziness": { 32 "normalized": 1.1, 33 "actual": "actual" 34 }, 35 "confidence": { 36 "normalized": 1.1, 37 "actual": "actual" 38 }, 39 "riskScore": 1.1, 40 "errorCode": "errorCode", 41 "errorMessage": "errorMessage" 42 }, 43 "result": "MATCH", 44 "class": "KYC", 45 "supplementaryData": { 46 "type": "MATCHLIST", 47 "attributes": [ 48 { 49 "attribute": { 50 "type": "ENTITY_TYPE", 51 "value": "value" 52 }, 53 "confidence": 1.1 54 } 55 ], 56 "confidence": 1.1, 57 "entityId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 58 "entityType": "INDIVIDUAL", 59 "entryId": "supplementaryData", 60 "matchlistId": "3fa85f64-5717-4562-b3fc-2c963f66afa6", 61 "notes": { 62 "key": { 63 "type": "type", 64 "value": "value" 65 } 66 }, 67 "reasons": [ 68 "SYNTHETIC_ID" 69 ], 70 "reference": "CERT-BAD-ACTOR-1234-5678" 71 }, 72 "errors": [ 73 { 74 "code": "code", 75 "description": "description", 76 "location": "location" 77 } 78 ], 79 "notes": { 80 "key": { 81 "type": "type", 82 "value": "value" 83 } 84 }, 85 "systemStatus": "VALID", 86 "manualStatus": "TRUE_POSITIVE", 87 "state": "IN_PROGRESS", 88 "riskFactors": [ 89 { 90 "factor": "factor", 91 "value": "value" 92 } 93 ], 94 "updatedBy": "updatedBy" 95 } 96 ] 97 }

1	curl -G https://api.uat.frankie.one/v2/individuals/entityId/results \
2	-H "X-Frankie-CustomerID: 12345678-1234-1234-1234-123456789012" \
3	-H "X-Frankie-CustomerChildID: 87654321-4321-4321-4321-210987654321" \
4	-H "X-Frankie-Username: fred.flintstone@frankieone.com" \
5	-H "api_key: <apiKey>" \
6	--data-urlencode createdAtBefore=2024-02-29T02:15:04Z \
7	--data-urlencode createdAtAfter=2024-02-29T02:15:04Z \
8	--data-urlencode updatedAtBefore=2024-02-29T02:15:04Z \
9	--data-urlencode updatedAtAfter=2024-02-29T02:15:04Z

1	{
2	"meta": {
3	"page": 1,
4	"total": 1,
5	"limit": 1,
6	"count": 1,
7	"sort": "asc",
8	"sortFields": [
9	"createdAt"
10	]
11	},
12	"requestId": "01HN9XHZN6MGXM9JXG50K59Q85",
13	"processResults": [
14	{
15	"processResultId": "processResultId",
16	"schemaVersion": 1,
17	"entityId": "entityId",
18	"requestId": "01HN9XHZN6MGXM9JXG50K59Q85",
19	"stepName": "stepName",
20	"stepType": "stepType",
21	"objectType": "objectType",
22	"objectId": "objectId",
23	"createdAt": "2024-01-15T09:30:00Z",
24	"updatedAt": "2024-01-15T09:30:00Z",
25	"groupId": "groupId",
26	"providerResult": {
27	"name": "name",
28	"source": "source",
29	"sourceNormalized": "sourceNormalized",
30	"reference": "reference",
31	"fuzziness": {
32	"normalized": 1.1,
33	"actual": "actual"
34	},
35	"confidence": {
36	"normalized": 1.1,
37	"actual": "actual"
38	},
39	"riskScore": 1.1,
40	"errorCode": "errorCode",
41	"errorMessage": "errorMessage"
42	},
43	"result": "MATCH",
44	"class": "KYC",
45	"supplementaryData": {
46	"type": "MATCHLIST",
47	"attributes": [
48	{
49	"attribute": {
50	"type": "ENTITY_TYPE",
51	"value": "value"
52	},
53	"confidence": 1.1
54	}
55	],
56	"confidence": 1.1,
57	"entityId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
58	"entityType": "INDIVIDUAL",
59	"entryId": "supplementaryData",
60	"matchlistId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
61	"notes": {
62	"key": {
63	"type": "type",
64	"value": "value"
65	}
66	},
67	"reasons": [
68	"SYNTHETIC_ID"
69	],
70	"reference": "CERT-BAD-ACTOR-1234-5678"
71	},
72	"errors": [
73	{
74	"code": "code",
75	"description": "description",
76	"location": "location"
77	}
78	],
79	"notes": {
80	"key": {
81	"type": "type",
82	"value": "value"
83	}
84	},
85	"systemStatus": "VALID",
86	"manualStatus": "TRUE_POSITIVE",
87	"state": "IN_PROGRESS",
88	"riskFactors": [
89	{
90	"factor": "factor",
91	"value": "value"
92	}
93	],
94	"updatedBy": "updatedBy"
95	}
96	]
97	}