checkRisk section provides the details of all of the risk factors that were applied to an entity in the latest round of checks in order to determine the final score.
The scores applied are based on the risk factors and scoring methodology you will be taken through when signing up for the FrankieOne service. We’ll then configure those rules and scores into the system for you.
The checkRisk section is a single ProcessResultObject with the following attributes:
| Field Name | Description |
|---|---|
| checkDate | UTC timestamp as to when the risk set was created. |
| checkId | The latest checkID when these risk checks were determined. |
| checkPerformedBy | Will always be builtin-risk. |
| checkSource | Will always be various. |
| checkType | Will be the full list of checks that are scheduled to be run as part of the recipe (or as requested in an ad-hoc query). |
| providerCheckId | Will always be the same as checkId above. |
| resultState | Will be one of: _ CHECKED_SUCCESS_CLEAR: risk calculation was successfully completed. This should always be the result, regardless of the final level of risk. _ CHECKED_FAILED: there was an error running the risk check. If you see this, please let FrankieOne dev support know and provide the entityID, requestID, and date/time of the error. |
| riskLevel | The final risk score |
resultNote Key-Value-Pairs will also be set:
| Key Name | Value Description |
|---|---|
| For every risk factor that was applied to this entity, there will be 2 or 3 KVPs that will describe the factor and the score applied. In the following key names a . <factor name>. is given. The <factor name> will be replaced with the name of the risk factor, with the same name in all 3 KVPs. See the example below for more. | |
risk_factor.<factor name>.value | The value of the risk factor that was scored |
risk_factor.<factor name>.score | The score applied to this risk factor |
risk_factor.<factor name>.description | (Optional) A human readable display name for the risk factor. |
The above 3 keys are repeated for every risk <factor name> configured | |
| Risk.Level | The overall level of risk for this entity. Will be one of: _ UNKNOWN (no risk checks applied as yet) _ LOW _ MEDIUM _ HIGH * UNACCEPTABLE |
| Risk.Bracket | A numeric representation of the above risk levels: _ 0 = UNKNOWN (no risk checks applied as yet) _ 1 = LOW _ 2 = MEDIUM _ 3 = HIGH * 4 = UNACCEPTABLE |
| Confidence.Level | Overall confidence in the risk score. This field is presently experimental and shouldn’t be used in your final determination. |
Example
Example Risk Results
"KYB (Business)": {
"checkRisk": {
"checkDate": "2021-08-16T08:59:31.578Z",
"checkPerformedBy": "builtin-risk",
"checkSource": "various",
"checkType": "visa,namev,manual,pep",
"resultNotes": [
{
"kvpKey": "risk_factor.num_pep.value",
"kvpType": "general.string",
"kvpValue": "No Match"
},
{
"kvpKey": "risk_factor.num_pep.score",
"kvpType": "general.integer",
"kvpValue": "10"
},
{
"kvpKey": "risk_factor.num_pep.description",
"kvpType": "general.string",
"kvpValue": "PEP Status"
},
{
"kvpKey": "risk_factor.num_sanctions.value",
"kvpType": "general.string",
"kvpValue": "Sanctions match"
},
{
"kvpKey": "risk_factor.num_sanctions.score",
"kvpType": "general.integer",
"kvpValue": "5000"
},
{
"kvpKey": "risk_factor.num_sanctions.description",
"kvpType": "general.string",
"kvpValue": "Sanctions Nexus"
},
{
"kvpKey": "risk_factor.internal_watchlist.value",
"kvpType": "general.string",
"kvpValue": "No Historical AML Risk Events"
},
{
"kvpKey": "risk_factor.internal_watchlist.score",
"kvpType": "general.integer",
"kvpValue": "10"
},
{
"kvpKey": "risk_factor.internal_watchlist.description",
"kvpType": "general.string",
"kvpValue": "FCC Risk Events"
},
{
"kvpKey": "risk_factor.num_adverse.value",
"kvpType": "general.string",
"kvpValue": "No flag"
},
{
"kvpKey": "risk_factor.num_adverse.score",
"kvpType": "general.integer",
"kvpValue": "10"
},
{
"kvpKey": "risk_factor.num_adverse.description",
"kvpType": "general.string",
"kvpValue": "Adverse media"
},
{
"kvpKey": "risk_factor.fund.value",
"kvpType": "general.string",
"kvpValue": "Not applicable"
},
{
"kvpKey": "risk_factor.fund.score",
"kvpType": "general.integer",
"kvpValue": "0"
},
{
"kvpKey": "risk_factor.fund.description",
"kvpType": "general.string",
"kvpValue": "Source of Funds"
},
{
"kvpKey": "risk_factor.cross_border.value",
"kvpType": "general.string",
"kvpValue": "Pure Domestic"
},
{
"kvpKey": "risk_factor.cross_border.score",
"kvpType": "general.integer",
"kvpValue": "5"
},
{
"kvpKey": "risk_factor.cross_border.description",
"kvpType": "general.string",
"kvpValue": "Cross-Border / Non-Residency Risk"
},
{
"kvpKey": "risk_factor.work_situation.value",
"kvpType": "general.string",
"kvpValue": "None"
},
{
"kvpKey": "risk_factor.work_situation.score",
"kvpType": "general.integer",
"kvpValue": "0"
},
{
"kvpKey": "risk_factor.work_situation.description",
"kvpType": "general.string",
"kvpValue": "Occupation Risk"
},
{
"kvpKey": "risk_factor.business.value",
"kvpType": "general.string",
"kvpValue": "Not applicable"
},
{
"kvpKey": "risk_factor.business.score",
"kvpType": "general.integer",
"kvpValue": "0"
},
{
"kvpKey": "risk_factor.business.description",
"kvpType": "general.string",
"kvpValue": "Business Risk (ISIC) Description"
},
{
"kvpKey": "risk_factor.residential_country.value",
"kvpType": "general.string",
"kvpValue": "None"
},
{
"kvpKey": "risk_factor.residential_country.score",
"kvpType": "general.integer",
"kvpValue": "0"
},
{
"kvpKey": "risk_factor.residential_country.description",
"kvpType": "general.string",
"kvpValue": "Jurisdictional Risk"
},
{
"kvpKey": "Risk.Level",
"kvpType": "general.string",
"kvpValue": "HIGH"
},
{
"kvpKey": "Risk.Bracket",
"kvpType": "general.integer",
"kvpValue": "3"
},
{
"kvpKey": "Confidence.Level",
"kvpType": "general.string",
"kvpValue": "HIGH"
}
],
"resultState": "CHECKED_SUCCESS_CLEAR",
"riskLevel": 5035
}
},