Understanding entity profile KYC results | FrankieOne

The results of a verification check (or a call to the endpoint GET /entity/{entityId}/checks) when an entity has a configured profile will still return all of the structures of the existing check results. There is however, an additional section/object named entityProfileResult. An example response would look something like the following:

Below is a brief summary of the properties contained in the `entityProfileResult`

Raw Result	Commentary	Type
entityProfileResult	This is the object response returned after making a call to this endpoint.	Object
actionRecommended	This is the same `actionRecommended` as found in the original `checkSummary`. It contains the result one of: `PASS` `PASS_MANUAL` `REFER` `FAIL` `FAIL_MANUAL` `UNCHECKED` It’s recommended you decide how to interpret these results.	String
addressResults	Each address gets its own results	Object
checkResults	For each `checkType` that was applied in this profile - did it PASS, FAIL or was NA (not applicable).	Array of Objects
checkType	The list of `checkTypes` applied as part of this profile.	String
documentResults	Like the addresses, we supply the results of each document that was checked.	Object
entityId	This is the entity Identifier. It’s recommended you store this value	String
issueList	This is the comma-separated list of issues Issue codes are: `404`: No match `500`: Service error `PTL`: Partial match only `PEP`: PEP match `S`: Sanctions match `WL`: AML Watchlist match `M`: Adverse Media match `FRAUD`: Fraud list or check match `DUP`: Duplicate `BL`: Blacklist `ATT`: No IDV data `ATT-IDV`: ID Validation failed `ATT-PHT`: Photo comparison failed `ATT-OCR`: OCR scanned document was modified `ATT-NCMP`: Biometrics Not Completed `FRAUD`: Fraud list match `DEVICE`: There was a device-fraud related issue `SUPPORT-DOCS`: Supporting Documents	String
kycResults	We break down each ID element that’s used to verify an entity.	Array of Objects
latestCheckDate	This describes when the check was last run.	String
manualIntervention	Was manual intervention required?	Boolean
profileName	Specify if profile name was applied.	String
riskLevel	Final risk level.	String
riskPolicy	Risk policy applied, based on the risk rules engine.	String

This new format gives a more detailed and clearer picture than having to dig through the original check results and checkSummary key/value pairs. But all of that raw data is still available if you request a full check result.

A summary result will return the checkRisk, checkSummary and entityProfileResult properties.

A simple result will just return the entityProfileResult property - although this only works for entity’s with a profile.

Example

entityProfileResult

1 "entityProfileResult": {
2         "actionRecommended": "PASS_MANUAL",
3         "addressResults": {
4            "a63d471b-9417-4474-0ee0-aa7310055e38": {
5                 "checked": true,
6                 "matchCount": 1,
7                 "matchSources" : [
8                     "au-ntd"
9                 ],
10                 "matchType": "curr_addr",
11                 "verified": true
12             }
13         },
14         "checkResults": [
15             {
16                 "checkType": "two_plus",
17                 "result": "PASS"
18             },
19             {
20                 "checkType": "id",
21                 "result": "PASS"
22             },
23             {
24                 "checkType": "pep_media",
25                 "result": "PASS"
26             },
27             {
28                 "checkType": "idvalidate",
29                 "code": "MISSING_PREREQUISITE",
30                 "message": "Attestation check succeeded. The attestation documents aren't present, but
31                            aren't required",
32                 "result": "NA"
33             }
34         ],
35         "checkType": "two_plus, id, pep_media, idvalidate",
36         "documentResults": {
37             "4a38bc35-f2de-77e0-cbbe-b3b27f644ce8": {
38                 "checked": true,
39                 "matchCount": 1,
40                 "matchSources" : [
41                     "au-govid-dl"
42                 ],
43                 "matchType": "gov_id",
44                 "verified": true
45             },
46             "9e658277-9bbc-11cc-1f83-593abf54ed6c": {
47                 "checked": true
48             }
49         },
50         "entityId": "b90d22ab-9571-48c9-6c66-1e7924501b9b",
51         "kycResults": [
52             {
53                 "matchCount": 3,
54                 "matchSources" : [
55                     "au-ntd",
56                     "au-elec-roll",
57                     "au-phone-pub"
58                 ],
59                 "matchCountRequired": 2,
60                 "matchTypes": {
61                     "name": {
62                         "checked": true,
63                         "matchCount": 3,
64                         "verified": true
65                     }
66                 },
67                 "verified": true
68 
69             },
70             {
71                 "matchCount": 4,
72                 "matchSources" : [
73                     "au-ntd",
74                     "au-elec-roll",
75                     "au-phone-pub",
76                     "au-asic"
77                 ],
78                 "matchCountRequired": 2,
79                 "matchTypes": {
80                     "address": {
81                         "checked": true,
82                         "matchCount": 1,
83                         "verified": true
84                     },
85                     "dob": {
86                         "checked": true,
87                         "matchCount": 3,
88                         "verified": true
89                     }
90                 },
91                 "verified": true
92             },
93             {
94                 "matchCount": 1,
95                 "matchSources" : [
96                     "au-govid1-dl"
97                 ],
98                 "matchCountRequired": 1,
99                 "matchTypes": {
100                     "gov_id": {
101                         "checked": true,
102                         "matchCount": 1,
103                         "verified": true
104                     }
105                 },
106                 "verified": true
107             }
108         ],
109         "latestCheckDate": "2020-08-09T14:04:35.624Z",
110         "manualIntervention": true,
111         "profileName": "default",
112         "riskLevel": "MEDIUM",
113         "riskPolicy": "CDD"
114     },
115   }

Example with a Partial Fail

EntityProfileResult Fail - Partial

1 {
2   "entityProfileResult": {
3     "actionRecommended": "FAIL",
4     "addressResults": {
5       "de2854e6-25cf-74b8-13ea-2df34b07b56c": {
6         "checked": true,
7         "nonmatchSources": [
8           "Equifax Public Credit Data Header",
9           "Equifax Proprietary Phone Directory",
10           "Australian Electoral Roll",
11           "Australian National Tenancy Database",
12           "Australian Public Phone Directory"
13         ]
14       }
15     },
16     "checkId": "28058802-2637-fbd9-c007-b4a91c5b881f",
17     "checkResults": [
18       {
19         "checkClass": "fraud",
20         "checkType": "blacklist",
21         "name": "Blacklist",
22         "result": "PASS"
23       },
24       {
25         "checkClass": "kyc",
26         "checkType": "two_plus",
27         "code": "PARTIAL_MATCH",
28         "message": "Partial Match",
29         "name": "2+2",
30         "result": "FAIL"
31       }
32     ],
33     "checkType": "blacklist,two_plus",
34     "creditHeaderFailures": ["Equifax"],
35     "entityId": "2de4a393-e868-c21d-8808-8ef8807693fc",
36     "issueList": ["PTL"],
37     "kycResults": [
38       {
39         "matchCount": 3,
40         "matchCountRequired": 2,
41         "matchTypes": {
42           "name": {
43             "checked": true,
44             "matchCount": 3,
45             "matchSources": [
46               "Australian Electoral Roll",
47               "Equifax Proprietary Phone Directory",
48               "Equifax Public Credit Data Header"
49             ],
50             "nonmatchSources": [
51               "Australian Public Phone Directory",
52               "Equifax Commercial Credit Data Header",
53               "Equifax Public Credit Data Header",
54               "IDMatrix"
55             ],
56             "verified": true
57           }
58         },
59         "verified": true
60       },
61       {
62         "matchCountRequired": 2,
63         "matchTypes": {
64           "address": {
65             "checked": true,
66             "nonmatchSources": [
67               "Australian Electoral Roll",
68               "Australian National Tenancy Database",
69               "Australian Public Phone Directory",
70               "Equifax Proprietary Phone Directory",
71               "Equifax Public Credit Data Header"
72             ]
73           },
74           "dob": {
75             "checked": true,
76             "nonmatchSources": ["Australian Electoral Roll", "IDMatrix"]
77           }
78         }
79       }
80     ],
81     "latestCheckDate": "2022-05-09T08:01:30.039Z",
82     "policyName": "default",
83     "profileName": "safe_harbour",
84     "riskLevel": "LOW",
85     "riskPolicy": "CDD"
86   }
87 }

Example with a No Match

EntityProfile No matches

{
	"entityProfileResult": {
		"actionRecommended": "FAIL",
		"checkId": "a4fa419c-31ac-2595-826a-3c4d5a1deabf",
		"checkResults": [
			{
				"checkClass": "fraud",
				"checkType": "blacklist",
				"name": "Blacklist",
				"result": "PASS"
			},
			{
				"checkClass": "kyc",
				"checkType": "id",
				"code": "NO_MATCH",
				"message": "No Match",
				"name": "Gov ID",
				"result": "FAIL"
			},
			{
				"checkClass": "kyc",
				"checkType": "two_plus",
				"code": "NO_MATCH",
				"message": "No Match",
				"name": "2+2",
				"result": "FAIL"
			},
			{
				"checkClass": "none",
				"checkType": "idvalidate",
				"code": "BLOCKED_BY_OTHER_FAIL",
				"message": "Gov ID check failed, therefore not running IDV check",
				"name": "IDV",
				"result": "UNCHECKED"
			},
			{
				"checkClass": "aml",
				"checkType": "pep",
				"code": "BLOCKED_BY_OTHER_FAIL",
				"message": "Gov ID check failed, therefore not running PEP/Sanctions check",
				"name": "PEP/Sanctions",
				"result": "UNCHECKED"
			}
		],
		"checkType": "blacklist,id,two_plus,idvalidate,pep",
		"creditHeaderFailures": [
			"Equifax"
		],
		"documentResults": {
			"9e7c3ca2-a199-3390-1254-6d524094e711": {
				"checked": true,
				"nonmatchSources": [
					"Australian Gov ID - Drivers Licence"
				]
			}
		},
		"entityId": "9b42d630-d5f8-8a57-1088-a84478e6f50d",
		"issueList": [
			"404"
		],
		"kycResults": [
			{
				"matchCountRequired": 1,
				"matchTypes": {
					"gov_id": {
						"checked": true,
						"nonmatchSources": [
							"Australian Gov ID - Drivers Licence"
						]
					}
				}
			},
			{
				"matchCountRequired": 2,
				"matchTypes": {
					"name": {
						"checked": true,
						"nonmatchSources": [
							"Equifax Commercial Credit Data Header",
							"Equifax Consumer Credit Data Header",
							"Equifax Public Credit Data Header",
							"IDMatrix"
						]
					}
				}
			},
			{
				"matchCountRequired": 2,
				"matchTypes": {
					"address": {},
					"dob": {
						"checked": true,
						"nonmatchSources": [
							"IDMatrix"
						]
					}
				}
			}
		],
		"latestCheckDate": "2023-08-14T05:48:29.000Z",
		"policyName": "default",
		"profileName": "safe_harbour_id",
		"riskLevel": "MEDIUM",
		"riskPolicy": "CDD"
	}
}