Get a risk assessment using Scorechain

POST 
/kyt/analysis

Get a risk assessment for a given wallet address using Scorechain. Requires the Scorechain provider.

Request

application/json

Body

required

analysisType stringnullable

Possible values: [ASSIGNED, INCOMING, OUTGOING, FULL]

objectType stringnullable

Possible values: [TRANSACTION, ADDRESS, WALLET]

objectId stringnullable

Address or transaction hash, depending on objectType

blockchain stringnullable

Possible values: [BITCOIN, BITCOINCASH, LITECOIN, DASH, ETHEREUM, RIPPLE, TEZOS, TRON, BSC, POLYGON, AVALANCHE, BASE, SOLANA]

coin object nullable

Coin (Use MAIN according to the docs)

anyOf

MOD1

string

MOD2

string

Possible values: [MAIN]

MOD3

string

Possible values: [ALL]

depth integernullable

Possible values: >= 1 and <= 100

customerId stringrequired

Responses

200

Successful response

application/json

Schema

Schema

anyOf
MOD1
id uuidrequired
analysis objectrequired
assigned objectrequired
hasResult booleanrequired
result objectnullable
score integerrequired
Possible values: <= 100
severity stringrequired
Possible values: [CRITICAL_RISK, HIGH_RISK, MEDIUM_RISK, LOW_RISK, NO_RISK, UNDEFINED_RISK]
details objectrequired
entity objectnullable
id integernullable
name stringrequired
type string
Possible values: [ATM, Airdrop, Auctioned assets, Bank, Block reward, Bot, Child abuse, Cloud mining, Community reported scam, Cross-chain Bridge Protocol, Darkweb, Decentralized service, Dex, Donations, Exchange, Gambling, Hack, ICO, Ignored small amounts, Investment management firm, Large transaction, Large unnamed entity, Mining pool, Mixing pattern, Mixing service, NFT Marketplace, No entities found, Ongoing legal action, Payment Service Provider, Payment channel, Peeling chain of unknown origin, Phishing, Ransomware, Real World Asset, Sanction list, Scam, Seized assets, Service, Staking pool, Suspicious, Terrorism, Token, Token burning, Token minting, Unspent output, Wallet, OFAC sanction list, Closed exchange, Custom group]
referenceAddress object required
anyOf
MOD1
string
MOD3
string
MOD4
string
MOD5
string
MOD6
string
MOD7
string
aiDetails objectnullable
entityTypeClassifier object[]required
Array [
type string
Possible values: [ATM, Airdrop, Auctioned assets, Bank, Block reward, Bot, Child abuse, Cloud mining, Community reported scam, Cross-chain Bridge Protocol, Darkweb, Decentralized service, Dex, Donations, Exchange, Gambling, Hack, ICO, Ignored small amounts, Investment management firm, Large transaction, Large unnamed entity, Mining pool, Mixing pattern, Mixing service, NFT Marketplace, No entities found, Ongoing legal action, Payment Service Provider, Payment channel, Peeling chain of unknown origin, Phishing, Ransomware, Real World Asset, Sanction list, Scam, Seized assets, Service, Staking pool, Suspicious, Terrorism, Token, Token burning, Token minting, Unspent output, Wallet, OFAC sanction list, Closed exchange, Custom group]
percent numberrequired
]
transaction objectnullable
type stringrequired
Possible values: [MINING, MIXING, LIGHTNING, CROSS_CHAIN]
riskAssessment objectrequired
score integerrequired
Possible values: >= 1 and <= 100
severity stringrequired
Possible values: [CRITICAL_RISK, HIGH_RISK, MEDIUM_RISK, LOW_RISK, NO_RISK, UNDEFINED_RISK]
customRiskAssessment objectnullable
score integerrequired
Possible values: >= 1 and <= 100
severity stringrequired
Possible values: [CRITICAL_RISK, HIGH_RISK, MEDIUM_RISK, LOW_RISK, NO_RISK, UNDEFINED_RISK]
risks object[]nullable
Array [
id integerrequired
type stringrequired
Possible values: [ENTITY_TYPE, ENTITY_COUNTRY, BEHAVIOR]
parameters objectrequired
referenceId integerrequired
referenceName object
anyOf
MOD3
string
threshold integerrequired
]
incoming objectnullable
hasResult booleanrequired
result objectnullable
score integerrequired
Possible values: <= 100
severity stringrequired
Possible values: [CRITICAL_RISK, HIGH_RISK, MEDIUM_RISK, LOW_RISK, NO_RISK, UNDEFINED_RISK]
details object[]nullable
Array [
referenceAddress object required
anyOf
MOD1
string
MOD3
string
MOD4
string
MOD5
string
MOD6
string
MOD7
string
amount numberrequired
amountUsd numbernullable
percentage numberrequired
name stringrequired
type object
anyOf
MOD1
string
Possible values: [ATM, Airdrop, Auctioned assets, Bank, Block reward, Bot, Child abuse, Cloud mining, Community reported scam, Cross-chain Bridge Protocol, Darkweb, Decentralized service, Dex, Donations, Exchange, Gambling, Hack, ICO, Ignored small amounts, Investment management firm, Large transaction, Large unnamed entity, Mining pool, Mixing pattern, Mixing service, NFT Marketplace, No entities found, Ongoing legal action, Payment Service Provider, Payment channel, Peeling chain of unknown origin, Phishing, Ransomware, Real World Asset, Sanction list, Scam, Seized assets, Service, Staking pool, Suspicious, Terrorism, Token, Token burning, Token minting, Unspent output, Wallet, OFAC sanction list, Closed exchange, Custom group]
MOD2
string
Possible values: [Unspent output, Block reward, Peeling chain of unknown origin, Payment channel, Large unnamed entity, Ignored small amounts, Large transaction, Mixing pattern, No entities found, Token minting, Token burning, Maximum exploration depth, Secondary coin creation, Secondary coin removal]
countries string[]required
score integerrequired
Possible values: <= 100
severity stringrequired
Possible values: [CRITICAL_RISK, HIGH_RISK, MEDIUM_RISK, LOW_RISK, NO_RISK, UNDEFINED_RISK]
aiDetails objectnullable
entityTypeClassifier object[]required
Array [
type string
Possible values: [ATM, Airdrop, Auctioned assets, Bank, Block reward, Bot, Child abuse, Cloud mining, Community reported scam, Cross-chain Bridge Protocol, Darkweb, Decentralized service, Dex, Donations, Exchange, Gambling, Hack, ICO, Ignored small amounts, Investment management firm, Large transaction, Large unnamed entity, Mining pool, Mixing pattern, Mixing service, NFT Marketplace, No entities found, Ongoing legal action, Payment Service Provider, Payment channel, Peeling chain of unknown origin, Phishing, Ransomware, Real World Asset, Sanction list, Scam, Seized assets, Service, Staking pool, Suspicious, Terrorism, Token, Token burning, Token minting, Unspent output, Wallet, OFAC sanction list, Closed exchange, Custom group]
percent numberrequired
]
]
risks object[]nullable
Array [
setting objectrequired
id integerrequired
type stringrequired
Possible values: [ENTITY_TYPE, ENTITY_COUNTRY, BEHAVIOR]
parameters objectrequired
referenceId integerrequired
referenceName object
anyOf
MOD3
string
threshold integerrequired
causes object[]nullable
Array [
referenceAddress object required
anyOf
MOD1
string
MOD3
string
MOD4
string
MOD5
string
MOD6
string
MOD7
string
amount numberrequired
amountUsd numbernullable
percentage numberrequired
name stringrequired
type object
anyOf
MOD1
string
Possible values: [ATM, Airdrop, Auctioned assets, Bank, Block reward, Bot, Child abuse, Cloud mining, Community reported scam, Cross-chain Bridge Protocol, Darkweb, Decentralized service, Dex, Donations, Exchange, Gambling, Hack, ICO, Ignored small amounts, Investment management firm, Large transaction, Large unnamed entity, Mining pool, Mixing pattern, Mixing service, NFT Marketplace, No entities found, Ongoing legal action, Payment Service Provider, Payment channel, Peeling chain of unknown origin, Phishing, Ransomware, Real World Asset, Sanction list, Scam, Seized assets, Service, Staking pool, Suspicious, Terrorism, Token, Token burning, Token minting, Unspent output, Wallet, OFAC sanction list, Closed exchange, Custom group]
MOD2
string
Possible values: [Unspent output, Block reward, Peeling chain of unknown origin, Payment channel, Large unnamed entity, Ignored small amounts, Large transaction, Mixing pattern, No entities found, Token minting, Token burning, Maximum exploration depth, Secondary coin creation, Secondary coin removal]
countries string[]required
score integerrequired
Possible values: <= 100
severity stringrequired
Possible values: [CRITICAL_RISK, HIGH_RISK, MEDIUM_RISK, LOW_RISK, NO_RISK, UNDEFINED_RISK]
aiDetails objectnullable
entityTypeClassifier object[]required
Array [
type string
Possible values: [ATM, Airdrop, Auctioned assets, Bank, Block reward, Bot, Child abuse, Cloud mining, Community reported scam, Cross-chain Bridge Protocol, Darkweb, Decentralized service, Dex, Donations, Exchange, Gambling, Hack, ICO, Ignored small amounts, Investment management firm, Large transaction, Large unnamed entity, Mining pool, Mixing pattern, Mixing service, NFT Marketplace, No entities found, Ongoing legal action, Payment Service Provider, Payment channel, Peeling chain of unknown origin, Phishing, Ransomware, Real World Asset, Sanction list, Scam, Seized assets, Service, Staking pool, Suspicious, Terrorism, Token, Token burning, Token minting, Unspent output, Wallet, OFAC sanction list, Closed exchange, Custom group]
percent numberrequired
]
]
]
outgoing objectnullable
hasResult booleanrequired
result objectnullable
score integerrequired
Possible values: <= 100
severity stringrequired
Possible values: [CRITICAL_RISK, HIGH_RISK, MEDIUM_RISK, LOW_RISK, NO_RISK, UNDEFINED_RISK]
details object[]nullable
Array [
referenceAddress object required
anyOf
MOD1
string
MOD3
string
MOD4
string
MOD5
string
MOD6
string
MOD7
string
amount numberrequired
amountUsd numbernullable
percentage numberrequired
name stringrequired
type object
anyOf
MOD1
string
Possible values: [ATM, Airdrop, Auctioned assets, Bank, Block reward, Bot, Child abuse, Cloud mining, Community reported scam, Cross-chain Bridge Protocol, Darkweb, Decentralized service, Dex, Donations, Exchange, Gambling, Hack, ICO, Ignored small amounts, Investment management firm, Large transaction, Large unnamed entity, Mining pool, Mixing pattern, Mixing service, NFT Marketplace, No entities found, Ongoing legal action, Payment Service Provider, Payment channel, Peeling chain of unknown origin, Phishing, Ransomware, Real World Asset, Sanction list, Scam, Seized assets, Service, Staking pool, Suspicious, Terrorism, Token, Token burning, Token minting, Unspent output, Wallet, OFAC sanction list, Closed exchange, Custom group]
MOD2
string
Possible values: [Unspent output, Block reward, Peeling chain of unknown origin, Payment channel, Large unnamed entity, Ignored small amounts, Large transaction, Mixing pattern, No entities found, Token minting, Token burning, Maximum exploration depth, Secondary coin creation, Secondary coin removal]
countries string[]required
score integerrequired
Possible values: <= 100
severity stringrequired
Possible values: [CRITICAL_RISK, HIGH_RISK, MEDIUM_RISK, LOW_RISK, NO_RISK, UNDEFINED_RISK]
aiDetails objectnullable
entityTypeClassifier object[]required
Array [
type string
Possible values: [ATM, Airdrop, Auctioned assets, Bank, Block reward, Bot, Child abuse, Cloud mining, Community reported scam, Cross-chain Bridge Protocol, Darkweb, Decentralized service, Dex, Donations, Exchange, Gambling, Hack, ICO, Ignored small amounts, Investment management firm, Large transaction, Large unnamed entity, Mining pool, Mixing pattern, Mixing service, NFT Marketplace, No entities found, Ongoing legal action, Payment Service Provider, Payment channel, Peeling chain of unknown origin, Phishing, Ransomware, Real World Asset, Sanction list, Scam, Seized assets, Service, Staking pool, Suspicious, Terrorism, Token, Token burning, Token minting, Unspent output, Wallet, OFAC sanction list, Closed exchange, Custom group]
percent numberrequired
]
]
risks object[]nullable
Array [
setting objectrequired
id integerrequired
type stringrequired
Possible values: [ENTITY_TYPE, ENTITY_COUNTRY, BEHAVIOR]
parameters objectrequired
referenceId integerrequired
referenceName object
anyOf
MOD3
string
threshold integerrequired
causes object[]nullable
Array [
referenceAddress object required
anyOf
MOD1
string
MOD3
string
MOD4
string
MOD5
string
MOD6
string
MOD7
string
amount numberrequired
amountUsd numbernullable
percentage numberrequired
name stringrequired
type object
anyOf
MOD1
string
Possible values: [ATM, Airdrop, Auctioned assets, Bank, Block reward, Bot, Child abuse, Cloud mining, Community reported scam, Cross-chain Bridge Protocol, Darkweb, Decentralized service, Dex, Donations, Exchange, Gambling, Hack, ICO, Ignored small amounts, Investment management firm, Large transaction, Large unnamed entity, Mining pool, Mixing pattern, Mixing service, NFT Marketplace, No entities found, Ongoing legal action, Payment Service Provider, Payment channel, Peeling chain of unknown origin, Phishing, Ransomware, Real World Asset, Sanction list, Scam, Seized assets, Service, Staking pool, Suspicious, Terrorism, Token, Token burning, Token minting, Unspent output, Wallet, OFAC sanction list, Closed exchange, Custom group]
MOD2
string
Possible values: [Unspent output, Block reward, Peeling chain of unknown origin, Payment channel, Large unnamed entity, Ignored small amounts, Large transaction, Mixing pattern, No entities found, Token minting, Token burning, Maximum exploration depth, Secondary coin creation, Secondary coin removal]
countries string[]required
score integerrequired
Possible values: <= 100
severity stringrequired
Possible values: [CRITICAL_RISK, HIGH_RISK, MEDIUM_RISK, LOW_RISK, NO_RISK, UNDEFINED_RISK]
aiDetails objectnullable
entityTypeClassifier object[]required
Array [
type string
Possible values: [ATM, Airdrop, Auctioned assets, Bank, Block reward, Bot, Child abuse, Cloud mining, Community reported scam, Cross-chain Bridge Protocol, Darkweb, Decentralized service, Dex, Donations, Exchange, Gambling, Hack, ICO, Ignored small amounts, Investment management firm, Large transaction, Large unnamed entity, Mining pool, Mixing pattern, Mixing service, NFT Marketplace, No entities found, Ongoing legal action, Payment Service Provider, Payment channel, Peeling chain of unknown origin, Phishing, Ransomware, Real World Asset, Sanction list, Scam, Seized assets, Service, Staking pool, Suspicious, Terrorism, Token, Token burning, Token minting, Unspent output, Wallet, OFAC sanction list, Closed exchange, Custom group]
percent numberrequired
]
]
]
lowestScore integerrequired
Possible values: <= 100
MOD2
error object required
anyOf
MOD2
error stringrequired
message stringrequired

Example (from schema)

{}

default

Error response

application/json

Schema

Schema

message stringrequired
code stringrequired
issues object[]
Array [
message stringrequired
]

Example (from schema)

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

Loading...