Initiaite an Individual Client Assessment

POST {{baseurl}}/v2/api/actors/risk/assessment

This endpoint allows you to initiate an individual client assessment, also known as an individual actor or entity, depending on your nomenclature. This is typically an individual you have a business or commercial relationship with.

Name
Type
Description

token*

String

API token

Body

Field
Type
Description

type*

String

type of customer - one of individual or business

firstName*

String

firstName of customer - if customer is individual

lastName*

String

lastName of customer - if customer is individual

middleName

String

middleName of customer - if customer is individual

businessName*

String

businessName of customer - if customer is business

city*

String

Address city - required for both types

country*

String

Address country code - required for both types

industry

String

industry of customer - applies for both types

lengthOfStay

Number

Address length Of Stay - in months, applies for both types

ageOfAccount

Number

Age of Account - in months, applies for both types

previousAdverseMediaScore

Number

Previous Adverse Media Score - applies for both types

previousRiskScore

Number

Previous Risk Score - applies for both types

adverseMediaQueryDateRange*

Object

Date Range for the adverse Media Query required for individual or business , but for beneficiaries send as "null"

startDate*

String

start Date for the adverse Media Query

endDate*

String

end Date for the adverse Media Query

kycVerifiedBy*

String

KYC verified By one of youverify - if KYC was verified by youverify, client - if KYC was verified by client, not_verified - if KYC has not been verified, expired_30 - if ID has expired within the last 30 days, expired_90 - if ID has expired within the last 90 days

isBeneficiary

Number

is the risk assessment for a transaction beneficiary - applies for both types, "true, if the risk assessment is for a transaction beneficiary, "false", if it's not"

customWeight

Object

business custom weight - if business has a custom weight set

kyc

Number

kyc weight

industry

Number

industry weight

city

Number

city weight

country

Number

country weight

sanction

Number

sanction weight

pep

Number

pep weight

adverse_media

Number

adverse media weight

{
    "type": "individual",
    "firstName": "Ahmed",
    "lastName": "Al Khalid",
    "middleName": null,
    "businessName": null,
    "city": "lagos",
    "country": "NG",
    "kycVerifiedBy": "not_verified",
    "lengthOfStay": 30,
    "industry": "arms_dealers",
    "ageOfAccount": 50,
    "previousAdverseMediaScore": 60,
    "previousRiskScore": 40,
    "adverseMediaQueryDateRange": {
        "startDate": "2023-05-23",
        "endDate": "2023-06-23"
    },
    "isBeneficiary": false
}
{
  "success": true,
  "statusCode": 200,
  "message": "customer assessment successful!",
  "data": {
  "success": true,
  "statusCode": 200,
  "message": "customer assessment successful!",
  "data": {
      "geographic": {
          "weight": 0.25,
          "country": "NG",
          "countryScore": 56.78,
          "countryScoreStatus": "Potential High Risk",
          "city": "lagos",
          "cityScore": 67.6,
          "cityScoreStatus": "Potential High Risk",
          "lengthOfStayScore": 50.000000002,
          "lengthOfStayScoreStatus": "Potential Medium Risk",
          "actualScore": 58.5330000006,
          "actualScoreStatus": "Potential Medium Risk",
          "weightedScore": 14.63325000015
      },
      "product": {
          "weight": 0.25,
          "industryScore": 100,
          "industryScoreStatus": "Potential High Risk",
          "occupationScore": 0,
          "occupationScoreStatus": "Low Risk",
          "actualScore": 90,
          "actualScoreStatus": "Critical High Risk",
          "weightedScore": 22.5
      },
      "personal": {
          "weight": 0.5,
          "name": "Twitter",
          "kycScore": 100,
          "kycScoreStatus": "Not Verified. High Risk.",
          "sanctionScore": 0,
          "sanctionScoreStatus": "Sanction Clear",
          "pepScore": 0,
          "pepScoreStatus": "PEP Clear",
          "adverseMediaScore": 77.23333333333333,
          "adverseMediaScoreStatus": "Potential High Risk",
          "pAdverseMediaScore": 60,
          "pAdverseMediaScoreStatus": "Potential Medium Risk",
          "accountAgeScore": 16.666666670000012,
          "accountAgeScoreStatus": "Potential Medium Risk",
          "citizenshipScore": 68.8,
          "citizenshipScoreStatus": "Potential High Risk",
          "actualScore": 42.279166667,
          "actualScoreStatus": "Potential Medium Risk",
          "weightedScore": 21.1395833335
      },
      "basicRiskScore": 58.27283333365,
      "previousRiskScore": 40,
      "riskScore": 58.27283333365,
      "riskStatus": "Potential Medium Risk",
      "adverseMediaNews": [
          {
              "date": "2023-06-18 14:50:43",
              "source": "https://www.foxbusiness.com/technology/twitter-kicked-out-colorado-offices-latest-court-battle-unpaid-rent",
              "headline": "Twitter kicked out of Colorado offices in latest court battle over unpaid rent",
              "excerpt": "A judge in Boulder, Colorado, ordered the sheriff's office to evict Twitter from office space locations over the company allegedly not paying rent, court documents show.",
              "score": 86.25999999999999,
              "inferring": "Negative",
              "tags": [
                  [
                      "civil lawsuit",
                      70
                  ]
              ],
              "language": "en",
              "persons": [
                  "Twitter ",
                  "David Odisho ",
                  "File ",
                  "Marlena Sloss/Bloomberg ",
                  "Elon Musk ",
                  "Musk "
              ],
              "organizations": [
                  "Boulder County ",
                  "Lot ",
                  "SBO ",
                  "Twitter ",
                  "Gregory Bull ",
                  "AP Newsroom ",
                  "TWITTER ",
                  "LANDLORD ",
                  "MUSK FOR ",
                  "Boulder ",
                  "FOX Business "
              ],
              "site": null,
              "country": "US",
              "_id": "64958838e58100661ccc3e9d"
          },
          {
              "date": "2023-06-15 08:24:21",
              "source": "https://finance.yahoo.com/news/music-publishers-are-suing-twitter-for-250-million-over-massive-copyright-infringement-082421118.html",
              "headline": "Music publishers are suing Twitter for $250 million over 'massive' copyright infringement",
              "excerpt": "Twitter has yet another major lawsuit to contend with. A group of more than a dozen music publishers has filed a $250 million lawsuit against the company over allegations of 'massive' copyright…",
              "score": 85.69,
              "inferring": "Negative",
              "tags": [
                  [
                      "piracy / counterfeiting",
                      80
                  ],
                  [
                      "sanction violations",
                      85
                  ]
              ],
              "language": "en",
              "persons": [
                  "Twitter ",
                  "Elon Musk ",
                  "Musk "
              ],
              "organizations": [
                  "NMPA Notices ",
                  "Twitter ",
                  "DMCA ",
                  "Digital Millennium "
              ],
              "site": null,
              "country": "US",
              "_id": "64958838e581006ea6cc3e9e"
          },
          {
              "date": "2023-06-08 05:08:27",
              "source": "https://www.infowars.com/posts/twitter-files-fbi-worked-with-ukraine-to-censor-twitter-users-including-journalists",
              "headline": "Twitter Files: FBI Worked With Ukraine to Censor Twitter Users, Including Journalists",
              "excerpt": "Infowars: There's a War on for your Mind!",
              "score": 81.41499999999999,
              "inferring": "Negative",
              "tags": [
                  [
                      "arms trafficking",
                      90
                  ]
              ],
              "language": "en",
              "persons": [
                  "Twitter ",
                  "Twitter Files ",
                  "Aaron MatΓ© ",
                  "Click ",
                  "Biden "
              ],
              "organizations": [
                  "FBI ",
                  "SBU ",
                  "Federal Bureau ",
                  "Security Service ",
                  "Twitter Files "
              ],
              "site": null,
              "country": "US",
              "_id": "64958838e581001805cc3e9f"
          },
          {
              "date": "2023-06-06 20:44:06",
              "source": "https://www.cnn.com/2023/06/06/tech/twitter-files-lawyers/index.html",
              "headline": "Twitter's own lawyers refute Elon Musk's claim that the β€˜Twitter Files' exposed US government censorship",
              "excerpt": "(CNN) β€” For months, Twitter owner Elon Musk and his allies have amplified baseless claims that the US government illegally coerced Twitter into censoring a 2020 New York Post article about Hunter…",
              "score": 88.35,
              "inferring": "Negative",
              "tags": [
                  [
                      "civil lawsuit",
                      70
                  ]
              ],
              "language": "en",
              "persons": [
                  "Twitter ",
                  "Elon Musk ",
                  "Hunter Biden ",
                  "Files ",
                  "Donald Trump ",
                  "Musk ",
                  "Joe Biden ",
                  "Trump ",
                  "Biden ",
                  "Plaintiffs ",
                  "Discovery Company "
              ],
              "organizations": [
                  "CNN ",
                  "Musk ",
                  "Twitter Files ",
                  "Twitter ",
                  "FBI ",
                  "Constitution ",
                  "First ",
                  "Trump ",
                  "US Capitol ",
                  "Cable News Network ",
                  "Warner Bros "
              ],
              "site": null,
              "country": "US",
              "_id": "64958838e5810004e5cc3ea0"
          },
          {
              "date": "2023-06-15 08:18:50",
              "source": "https://images.dawn.com/news/1191859",
              "headline": "Twitter hit with $250mn copyright infringement lawsuit from music publishers",
              "excerpt": "The lawsuit claims that the problem of copyright infringement on Twitter has escalated since the platform came under the ownership of Elon Musk.",
              "score": 80.465,
              "inferring": "Negative",
              "tags": [
                  [
                      "sanction violations",
                      85
                  ],
                  [
                      "piracy / counterfeiting",
                      80
                  ]
              ],
              "language": "en",
              "persons": [
                  "Universal Music Publishing Group ",
                  "Warner Chappell Music ",
                  "Sony Music Publishing ",
                  "Twitter ",
                  "Drake ",
                  "Taylor Swift ",
                  "Adele ",
                  "Peloton ",
                  "Roblox ",
                  "David Israelite ",
                  "Variety ",
                  "Elon Musk "
              ],
              "organizations": [
                  "NMPA ",
                  "USA ",
                  "TikTok ",
                  "DMCA ",
                  "CEO ",
                  "Publishers ",
                  "Twitter "
              ],
              "site": null,
              "country": "IN",
              "_id": "64958838e581006d14cc3ea1"
          },
          {
              "date": "2023-06-14 22:39:48",
              "source": "https://www.slashgear.com/1314345/twitter-sued-songwriters-music-copyright-violations/",
              "headline": "Twitter Hit With $250 Million Lawsuit Over Alleged Music Copyright Violations",
              "excerpt": "Elon Musk's financially-strained Twitter has been hit with a lawsuit seeking $250 million over its alleged ongoing music copyright infringement issues.",
              "score": 83.22000000000001,
              "inferring": "Negative",
              "tags": [
                  [
                      "piracy / counterfeiting",
                      80
                  ],
                  [
                      "civil lawsuit",
                      70
                  ],
                  [
                      "sanction violations",
                      85
                  ]
              ],
              "language": "en",
              "persons": [
                  "Twitter ",
                  "Musk "
              ],
              "organizations": [
                  "Twitter ",
                  "NMPA "
              ],
              "site": null,
              "country": "US",
              "_id": "64958838e58100baf0cc3ea2"
          },
          {
              "date": "2023-06-14 21:40:22",
              "source": "https://seekingalpha.com/news/3979991-music-publishers-sue-twitter-over-alleged-copyright-infringement",
              "headline": "Music publishers sue Twitter over alleged copyright infringement (NYSE:SONY)",
              "excerpt": "The National Music Publishers Association sued Twitter, claiming that the social media platform violates the copyright of songwriters by using their music without permission. A group of...",
              "score": 90.345,
              "inferring": "Negative",
              "tags": [
                  [
                      "piracy / counterfeiting",
                      80
                  ],
                  [
                      "sanction violations",
                      85
                  ]
              ],
              "language": "en",
              "persons": [
                  "Twitter ",
                  "Warner Music Group ",
                  "Sony Music ",
                  "Elon Musk ",
                  "Musk ",
                  "Twitter U.S. ",
                  "Linda Yaccarino ",
                  "Twitter CEO "
              ],
              "organizations": [
                  "NASDAQ ",
                  "NYSE ",
                  "OTCPK ",
                  "Twitter "
              ],
              "site": null,
              "country": "US",
              "_id": "64958838e581002c98cc3ea3"
          },
          {
              "date": "2023-06-15 08:24:21",
              "source": "https://www.engadget.com/music-publishers-are-suing-twitter-for-250-million-over-massive-copyright-infringement-082421118.html",
              "headline": "Music publishers are suing Twitter for $250 million over 'massive' copyright infringement",
              "excerpt": "A group of more than a dozen music publishers is suing Twitter for $250 million over allegations of 'massive' copyright infringement on the platform..",
              "score": 85.69,
              "inferring": "Negative",
              "tags": [
                  [
                      "piracy / counterfeiting",
                      80
                  ],
                  [
                      "sanction violations",
                      85
                  ]
              ],
              "language": "en",
              "persons": [
                  "Twitter ",
                  "Elon Musk ",
                  "Musk "
              ],
              "organizations": [
                  "NMPA Notices ",
                  "Twitter ",
                  "DMCA ",
                  "Digital Millennium ",
                  "Engadget "
              ],
              "site": null,
              "country": "US",
              "_id": "64958838e58100d345cc3ea4"
          },
          {
              "date": "2023-06-15 15:44:00",
              "source": "https://news.yahoo.com/music-labels-sue-twitter-250-154400196.html",
              "headline": "Music Labels Sue Twitter for $250 Million as Its Reputation Circles the Drain",
              "excerpt": "Music labels sued Twitter for copyright infringement in a class action lawsuit filed on Wednesday. The labels claim the social media company used copyrighted music to increase the amount of time users…",
              "score": 82.365,
              "inferring": "Negative",
              "tags": [
                  [
                      "piracy / counterfeiting",
                      80
                  ],
                  [
                      "sanction violations",
                      85
                  ]
              ],
              "language": "en",
              "persons": [
                  "Twitter ",
                  "Taylor Swift ",
                  "Elon Musk ",
                  "David Israelite ",
                  "Musk ",
                  "Instagram ",
                  "Linda Yaccarino ",
                  "Gizmodo "
              ],
              "organizations": [
                  "NMPA ",
                  "Digital Millennium ",
                  "DMCA ",
                  "TikTok ",
                  "YouTube ",
                  "CEO ",
                  "Twitter "
              ],
              "site": null,
              "country": "US",
              "_id": "64958838e58100c6cccc3ea5"
          },
          {
              "date": "2023-05-31 11:20:19",
              "source": "https://www.indiatimes.com/technology/news/twitter-could-face-europe-ban-604433.html",
              "headline": "EU Demands Twitter's Compliance With Disinformation Rules Or Risk Ban",
              "excerpt": "When Elon Musk bought Twitter last year, he said that one of the key factors driving his purchase was his commitment to ensure freedom of expression and transparency",
              "score": 78.85,
              "inferring": "Negative",
              "tags": [
                  [
                      "fraud",
                      90
                  ],
                  [
                      "sanction violations",
                      85
                  ]
              ],
              "language": "en",
              "persons": [
                  "Twitter ",
                  "France Info ",
                  "Jean-NoΓ«l Barrot ",
                  "Barrot ",
                  "Thierry Breton ",
                  "Beyond ",
                  "Elon Musk ",
                  "Musk ",
                  "Unsplash ",
                  "Elon Musk Teases New Twitter Features Including Voice Calls ",
                  "Earlier "
              ],
              "organizations": [
                  "European Union ",
                  "Digital ",
                  "Meta ",
                  "Microsoft ",
                  "Digital Services ",
                  "Commissioner ",
                  "Internal Market ",
                  "Twitter ",
                  "DSA ",
                  "Reuters ",
                  "Community Notes ",
                  "Encrypted "
              ],
              "site": null,
              "country": "IN",
              "_id": "64958838e581002493cc3ea6"
          },
          {
              "date": "2023-06-14 20:55:46",
              "source": "https://variety.com/2023/music/news/twitter-250-million-copyright-infringement-lawsuit-music-publishers-1235644414/",
              "headline": "Twitter Hit With $250 Million Copyright-Infringement Lawsuit From Music Publishers",
              "excerpt": "The National Music Publishers Assn., acting on behalf of 17 major music publishers, is filing a federal copyright infringement lawsuit against Twitter for its failure to license and pay for the mus…",
              "score": 81.13,
              "inferring": "Negative",
              "tags": [
                  [
                      "sanction violations",
                      85
                  ],
                  [
                      "piracy / counterfeiting",
                      80
                  ]
              ],
              "language": "en",
              "persons": [
                  "Twitter ",
                  "Anthem Entertainment ",
                  "Big Machine Music ",
                  "Hipgnosis Songs Group ",
                  "Kobalt Music ",
                  "Mayimba Music ",
                  "Reservoir Media Management ",
                  "Sony Music Publishing ",
                  "Spirit Music Group ",
                  "Ultra Music Publishing ",
                  "Warner Chappell Music ",
                  "Wixen Music Publishing ",
                  "Peloton ",
                  "Roblox ",
                  "Elon Musk ",
                  "David Israelite "
              ],
              "organizations": [
                  "Publishers ",
                  "Twitter ",
                  "UMPG ",
                  "ABKCO Music ",
                  "Royalty Network ",
                  "NMPA ",
                  "TikTok ",
                  "CEO ",
                  "DMCA "
              ],
              "site": null,
              "country": "US",
              "_id": "64958838e5810004d2cc3ea7"
          },
          {
              "date": "2023-05-31 18:00:00",
              "source": "https://www.globenewswire.com/news-release/2023/05/31/2679728/0/en/UPDATE-Berliner-Tageszeitung-Criminal-complaint-in-Berlin-Germany-against-Elon-Musk-and-Twitter-for-possible-fraud-to-the-detriment-of-users.html",
              "headline": "UPDATE – Berliner Tageszeitung: Criminal complaint in Berlin, Germany, against Elon Musk and Twitter for possible fraud to the detriment of users",
              "excerpt": "BERLIN, May 31, 2023 (GLOBE NEWSWIRE) -- BERLINER TAGESZEITUNG reports today that a criminal complaint has been filed against Elon Musk with the Berlin...",
              "score": 82.935,
              "inferring": "Negative",
              "tags": [
                  [
                      "fraud",
                      90
                  ]
              ],
              "language": "en",
              "persons": [
                  "Elon Musk ",
                  "Musk ",
                  "Twitter ",
                  "Source ",
                  "Tesla CEO Elon Musk ",
                  "Edward Chen ",
                  "Elon Musk Twitter ",
                  "Elon Musk Strafanzeige ",
                  "Thierry Breton ",
                  "Thierry Breton Twitter ",
                  "Berlin ",
                  "Berliner Tageszeitung "
              ],
              "organizations": [
                  "GLOBE ",
                  "BERLINER ",
                  "Berlin ",
                  "Twitter ",
                  "Federal Republic ",
                  "US ",
                  "District Court ",
                  "Fundamental Rights ",
                  "European Union ",
                  "META "
              ],
              "site": null,
              "country": "US",
              "_id": "64958838e5810016d0cc3ea8"
          },
          {
              "date": "2023-06-13 17:15:06",
              "source": "https://www.business-standard.com/india-news/mos-it-slams-former-twitter-founder-dorsey-s-comments-on-farmer-protest-123061300673_1.html",
              "headline": "Chandrasekhar slams Twitter ex-CEO Dorsey's comments on farmer protest",
              "excerpt": "Jack Dorsey: \"This is an outright lie by @jack - perhaps an attempt to brush out that very dubious period of Twitters history,\" said the Minister in his tweet",
              "score": 89.585,
              "inferring": "Negative",
              "tags": [
                  [
                      "fraud",
                      90
                  ],
                  [
                      "falsifying information on official documents",
                      80
                  ]
              ],
              "language": "en",
              "persons": [
                  "Shivani ",
                  "Shinde Mumbai ",
                  "Jack Dorsey ",
                  "Twitter ",
                  "Chandrasekhar ",
                  "Dorsey ",
                  "Dorseys Twitter ",
                  "Such ",
                  "Jack ",
                  "Bluesky Social ",
                  "Irdai ",
                  "Sahara ",
                  "Safe ",
                  "Jack Dorsey Twitter "
              ],
              "organizations": [
                  "Farmer Protests ",
                  "YouTube ",
                  "CEO Twitter ",
                  "USA ",
                  "CAG ",
                  "SAT ",
                  "Life Insurance ",
                  "SBI Life "
              ],
              "site": null,
              "country": "IN",
              "_id": "64958838e581002e7ecc3ea9"
          },
          {
              "date": "2023-06-15 15:44:00",
              "source": "https://gizmodo.com/twitter-nmpa-music-labels-sue-copyright-infringement-1850543130",
              "headline": "Music Labels Sue Twitter for $250 Million in Copyright Infringement",
              "excerpt": "Twitter is facing yet another lawsuit. 17 music labels representing Beyonce, Taylor Swift, and others are alleging major copyright infringement.",
              "score": 82.07999999999998,
              "inferring": "Negative",
              "tags": [
                  [
                      "piracy / counterfeiting",
                      80
                  ]
              ],
              "language": "en",
              "persons": [
                  "Twitter ",
                  "Taylor Swift ",
                  "Elon Musk ",
                  "David Israelite ",
                  "Musk ",
                  "Instagram ",
                  "Linda Yaccarino "
              ],
              "organizations": [
                  "NMPA ",
                  "Digital Millennium ",
                  "DMCA ",
                  "TikTok ",
                  "YouTube ",
                  "CEO ",
                  "Twitter "
              ],
              "site": null,
              "country": "US",
              "_id": "64958838e58100df71cc3eaa"
          },
          {
              "date": "2023-05-23 18:00:18",
              "source": "https://www.makeuseof.com/twitters-history-security-lapses/",
              "headline": "Twitter's History of Security Lapses and How They Affected Users",
              "excerpt": "Twitter's suffered many data breaches in the past, affecting millions of users. Only by knowing of these breaches can you protect yourself in future.",
              "score": 81.89000000000001,
              "inferring": "Negative",
              "tags": [
                  [
                      "sanction violations",
                      85
                  ],
                  [
                      "cybercrime / hacking / phishing",
                      80
                  ]
              ],
              "language": "en",
              "persons": [
                  "Twitter ",
                  "Barack Obama ",
                  "Partner Audiences ",
                  "Guardian ",
                  "Omar Abdulaziz ",
                  "Google Play Store ",
                  "Elon Musk ",
                  "Bill Gates ",
                  "Kanye West ",
                  "Joe Biden ",
                  "Biden "
              ],
              "organizations": [
                  "Associated ",
                  "Tailored Audiences "
              ],
              "site": null,
              "country": "CA",
              "_id": "64958838e58100d8e2cc3eab"
          }
      ],
      "adverseMediaNewsReason": " The lawsuit alleges that Twitter has violated the copyright of songwriters by using their music without permission."
  },
  "links": []
}

{
  "success": false,
  "statusCode": 404,
  "message": "You have attempted to get a resource that does not exist.",
  "name": "ResourceNotFoundError",
  "data": {}
}

Last updated