API Reference
Log inSign up
v1.7.3
v1.7.3
  • ComplyCube API Reference
  • Integration
  • Test and Live
  • Authentication
  • Rate Limits
  • Service Quota
  • Errors
  • Pagination
  • Filtering
  • Versioning
  • Core resources
    • Clients
      • Create a client
      • Get a client
      • Update a client
      • Delete a client
      • List clients
      • Filtering clients
    • Addresses
      • Create an address
      • Get an address
      • Update an address
      • Delete an address
      • List addresses
      • Filtering addresses
    • Documents
      • Create a document
      • Get a document
      • Update a document
      • Upload image attachment
      • Delete image attachment
      • Download image attachment
      • Redact image attachment
      • Delete a document
      • List documents
      • Filtering documents
    • Live Photos
      • Upload a live photo
      • Get a live photo
      • Download live photo
      • Redact live photo
      • Delete a live photo
      • List live photos
    • Live Videos
      • Get a live video
      • Redact live video
      • Delete live video
      • List live videos
    • Checks
      • Create a check
      • Get a check
      • Update a check
      • Validate check outcome
      • Redact check outcome
      • List checks
      • Filtering checks
    • Risk Profile
      • Get a risk profile
  • Check types
    • AML Screening Check
    • Document Check
    • Identity Check
    • Enhanced Identity Check
    • Proof of Address Check
    • Multi-Bureau Check
    • Face Authentication Check
    • Age Estimation Check
  • Lookups
    • Company Search
      • Search company
      • Get company details
    • Address Search
      • Search address
  • Tools
    • Custom Lists
      • Get a custom list
      • Add entity to custom list
      • List custom lists
  • Static Data
    • Screening Lists
    • Supported Documents
  • Other Resources
    • Flow (Hosted Solution)
      • Create a session
    • Webhooks
      • Create a webhook
      • Get a webhook
      • Update a webhook
      • Delete a webhook
      • List webhooks
      • Filtering webhooks
    • SDK Tokens
      • Generate a token
    • Autofill
      • Perform autofill
    • Reports
      • Generate a client report
      • Generate a check report
    • Team Members
      • Get a team member
      • List team members
      • Filtering team members
    • Audit Logs
      • Get an audit log
      • List audit logs
      • Filtering audit logs
    • Account Info
      • Get account info
  • Useful Resources
    • Testing Data
    • User Docs
Powered by GitBook
On this page
  • The Risk Profile object
  • The countryRisk object

Was this helpful?

  1. Core resources

Risk Profile

ComplyCube automatically generates an AML risk score for your clients.

PreviousFiltering checksNextGet a risk profile

Last updated 1 year ago

Was this helpful?

A Risk Profile provides you with an AML risk score for a given client. It facilitates a for Client Due Diligence (CDD) and Enhanced Due Diligence (EDD). Furthermore, the risk profile will assist you in shaping your ongoing client relationship. .

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 does not have sufficient details.

The Risk Profile object

Attribute
Type
Description

overallRisk

string

The overall risk score. Valid values are:

  1. low

  2. medium

  3. high

  4. not_set

countryRisk

object

politicalExposureRisk

object

occupationRisk

object

watchlistRisk

object

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

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. source: The name of the country metrics publishing authority.

  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.

This contains the country risk score and breakdown. Also, see the object below.

This contains the political exposure risk score and breakdown. Also, see the object below.

This contains the occupation risk score and breakdown. Also, see the object below.

This contains the watchlist risk score and breakdown. Also, see the object below.

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 .

risk-based framework
Learn more about Risk Profile
client
two-letter country ISO code
countryRisk
politicalExposureRisk
occupationRisk
watchlistRisk