API Reference
v1.7.3
Search…
⌃K

Risk Profile

ComplyCube automatically generates an AML risk score for your clients.
A Risk Profile provides you with an AML risk score for a given client. It facilitates a risk-based framework for Client Due Diligence (CDD) and Enhanced Due Diligence (EDD). Furthermore, the risk profile will assist you in shaping your ongoing client relationship. Learn more about Risk Profile.
ComplyCube's proprietary risk model calculates the risk profile. The value of the overall score, or a constituent risk score, will be not_set if the client does not have sufficient details.

The Risk Profile object

Attribute
Type
Description
overallRisk
string
The overall risk score. Valid values are:
  1. 1.
    low
  2. 2.
    medium
  3. 3.
    high
  4. 4.
    not_set
countryRisk
object
This contains the country risk score and breakdown. Also, see the countryRisk object below.
politicalExposureRisk
object
This contains the political exposure risk score and breakdown. Also, see the politicalExposureRisk object below.
occupationRisk
object
This contains the occupation risk score and breakdown. Also, see the occupationRisk object below.
watchlistRisk
object
This contains the watchlist risk score and breakdown. Also, see the watchlistRisk object below.
updatedAt
string
The date and time when the risk profile was updated.
​

The countryRisk object

Attribute
Type
Description
risk
string
The overall country risk score.
country
string
The country with the highest risk. This can be any country associated with the client, be it nationality, birth country, address, etc. It will be the two-letter country ISO code.
breakdown
array[object]
This contains all the constituents used to derive the score for the country with the highest risk. It is an array of objects, comprising of the following:
  1. 1.
    source: The name of the country metrics publishing authority.
  2. 2.
    normalisedRiskScore: The normalised risk score for that authority.
​

The politicalExposureRisk object

Attribute
Type
Description
risk
string
The political exposure risk score.
checkId
string
The check ID that triggered the score.
​

The occupationRisk object

Attribute
Type
Description
risk
string
The political exposure risk score.
checkId
string
The related check ID that triggered the score.
occupationCategory
string
The occupation category has been risk assessed.
occupationTitle
string
The occupation title has been risk assessed.
​

The watchlistRisk object

Attribute
Type
Description
risk
string
The watchlist risk score.
checkId
string
The check ID that triggered the score.
Previous
Filtering checks
Next
Get a risk profile
Last modified 1mo ago