This endpoint allows users to retrieve labels information for the address.
\n"},"isInherited":true,"source":{"_postman_id":"3a930aba-c901-47c9-b7ea-be7b8883f8b1","id":"3a930aba-c901-47c9-b7ea-be7b8883f8b1","name":"SkyInsights API V3","type":"collection"}},"urlObject":{"protocol":"https","path":["v3","kya","labels"],"host":["api","skyinsights","certik","com"],"query":[],"variable":[]}},"response":[{"id":"9ba33464-62d1-44b3-b713-4402ec894619","name":"v3/kya/labels","originalRequest":{"method":"GET","header":[],"url":{"raw":"https://api.skyinsights.certik.com/v3/kya/labels?chain=eth&address=0xf81a676e51f1cd18d78abdb7bf3467ca2bf97f7d","protocol":"https","host":["api","skyinsights","certik","com"],"path":["v3","kya","labels"],"query":[{"key":"chain","value":"eth"},{"key":"address","value":"0xf81a676e51f1cd18d78abdb7bf3467ca2bf97f7d"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Date","value":"Tue, 21 May 2024 20:23:18 GMT"},{"key":"Content-Type","value":"application/json; charset=utf-8"},{"key":"Content-Length","value":"248"},{"key":"Connection","value":"keep-alive"},{"key":"X-Powered-By","value":"Express"},{"key":"Vary","value":"Origin"},{"key":"Access-Control-Allow-Credentials","value":"true"},{"key":"X-RateLimit-Limit","value":"3000"},{"key":"X-RateLimit-Remaining","value":"2999"},{"key":"X-RateLimit-Reset","value":"15"},{"key":"ETag","value":"W/\"f8-nNBwV/WC16Jd9ERcnhTOLP5uIYo\""}],"cookie":[],"responseTime":null,"body":"{\n \"address\": \"0xf81a676e51f1cd18d78abdb7bf3467ca2bf97f7d\",\n \"chain\": \"eth\",\n \"labels\": [\n {\n \"confidence_level\": 100,\n \"general\": \"Scam\",\n \"name\": \"VoltNFT\",\n \"subtype\": \"Honey_Pot\"\n },\n {\n \"confidence_level\": 100,\n \"general\": \"Token\",\n \"name\": \"VoltNFT\",\n \"subtype\": \"Token_Address\"\n }\n ]\n}"}],"_postman_id":"021cf801-5909-48f2-ba06-2e308a6a6f96"},{"name":"v3/kya/screening","id":"ec6cf02a-2062-4fa5-9fec-5fc268488f30","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.skyinsights.certik.com/v3/kya/screening","description":"Provides risk assesment for on-chain addresses. You can specify the various parameters to fit your various needs.
\nParameter
\n\n- For detail
minimal or detailed \n
\n\n\n\n| Parameter | \nType | \nDescription | \n
\n\n\n\n| chain | \nstring | \nThe chain of the address.
Supporting the following chains: eth, bsc, btc, polygon, avax, arbitrum-one, tron, optimism, wemix, play, tornado, and multi-chain.
Lite supporting the following chains: kava, gnosis, cronos, celo, base, bch, ltc, arbitrum-nova, pulsechain, manta, ronin, mantle, hedera, zksync. | \n
\n\n| address | \nstring | \ne.g. 0x098b716b8aaf21512996dc57eb0615e2383e2f96 | \n
\n\n| exposure_limit | \nstring | \nThe sensitivity of the risk exposures, e.g. origin, direct, indirect | \n
\n\n| detail(Optional) | \nstring | \nLevel of detail to return in the risk response, e.g. minimal, detailed
Default is minimal | \n
\n\n| risk_types(Optional) | \nstring | \nThe types of risks to receive summarized information from, in the foramt of a comma separated string, e.g. sanction, hack
Supporting the following types: rugpull_exit_scam, hack, ransomware, flashloan_exploiter, scam, phishing, exploitation, honeypot, sanction, mixer, industry_blocklist, terrorism, darknet, etc. | \n
\n\n| start_timestamp(Optional) | \nnumber | \nunix timestamp, e.g. 1650782869 | \n
\n\n| end_timestamp(Optional) | \nnumber | \nunix timestamp, e.g. 1650782869 | \n
\n\n| min_usd_amount(Optional) | \nnumber | \nThe min usd amount of the fund in a summarized risk. | \n
\n\n
\n
\n- For detail
comprehensive \n
\n\n\n\n| Parameter | \nType | \nDescription | \n
\n\n\n\n| chain | \nstring | \nThe chain of the address.
Supporting the following chains: eth, bsc, btc, polygon, avax, arbitrum-one, tron, optimism, wemix, play, tornado, and multi-chain.
Lite supporting the following chains: kava, gnosis, cronos, celo, base, bch, ltc, arbitrum-nova, pulsechain, manta, ronin, mantle, hedera, zksync | \n
\n\n| address | \nstring | \ne.g. 0x098b716b8aaf21512996dc57eb0615e2383e2f96 | \n
\n\n| exposure_limit | \nstring | \nThe sensitivity of the risk exposures, e.g. origin, direct, indirect | \n
\n\n| detail(Optional) | \nstring | \nLevel of detail to return in the risk response, e.g. comprehensive
Default is minimal | \n
\n\n| page(Optional) | \nnumber | \nThe page of risk_exposures.
Default is 1 | \n
\n\n
\n
Response
\nA high level risk score is calculated for the address. This score is a combination of a variety of factors which largely comprise of known associations with bad actors, illicit funds activity, on-chain activity patterns and security analysis.
\nThe level of detail can be specified for the response when making the request. Compared with minimal version, the detailed version will provide the data sources and asset_flow_summary in risks object. The comprehensive version will provide two more objects, risk_events and risk_exposures.
\nThe response from the API will consist of the following fields.
\n\n\n\n| Field | \nType | \nDescription | \n
\n\n\n\n| address | \nstring | \nThe address that was provided. | \n
\n\n| chain | \nstring | \nThe chain of the address that was provided. | \n
\n\n| exposure_limit | \nstring | \nThe exposure limit that was provided, e.g. origin, direct, indirect | \n
\n\n| risk_score | \nnumber | \nThe risk score of the address, ranges between 0 - 100. | \n
\n\n| risks | \nRiskDescription[] | \nA list of RiskDescription associated with the address. | \n
\n\n| risk_events | \nRiskEvent[] | \nA list of RiskEvent associated with the address.
Only for comprehensive detail | \n
\n\n| risk_exposures | \nRiskExposure | \nAn object of paginated RiskExposure associated with the address.
Only for comprehensive detail | \n
\n\n
\n
RiskDescription
\nA risk description, is unique based on the risk_type field and provides a high level of description of the risks associated with a given address.
\n\n\n\n| Field | \nType | \nDescription | \n
\n\n\n\n| risk_type | \nstring | \nThe type of risk for this risk description. Each risk description will be unique by it's risk type | \n
\n\n| total_events | \nnumber | \nThe number of known events (incidents) that are associated with this risk_type | \n
\n\n| total_exposures | \nnumber | \nThe number of known exposures (transfers) that are associated with this risk_type | \n
\n\n| proximities | \nstring[] | \nThe exposure proximities that are applicable for this risk description. This can be filtered by the exposure_limit parameter. | \n
\n\n| sources | \nstring[] | \nThe list of source for this risk description.
The two most common sources will be: CertiK Investigations and OSINT . For other sources it will be in the format of other - {source}
Only for detailed detail | \n
\n\n| risk_asset_flow_summary | \nRiskAssetFlowSummary[] | \nA list of RiskAssetFlowSummary for this risk description. This will provide incoming and outgoing flows for USD, Native and Major Top Tokens.
Only for detailed detail | \n
\n\n
\n
RiskAssetFlowSummary
\n\n\n\n| Field | \nType | \nDescription | \n
\n\n\n\n| asset | \nstring | \nAsset name, can be USD or the Native Token (ex: ETH) or the token address. | \n
\n\n| incoming_amount | \nnumber | \nAmount of risky tokens that this address has received. | \n
\n\n| outgoing_amount | \nnumber | \nAmount of risky tokens that this address has sent. | \n
\n\n| incoming_usd_amount | \nnumber | \nHistorical USD conversion/amount of the risky tokens that the address has received. | \n
\n\n| outgoing_usd_amount | \nnumber | \nHistorical USD conversion/amount of the risky tokens that the address has sent. | \n
\n\n
\n
*USD pricing of tokens is based on historical prices and is a close estimate.
\nRiskEvent
\n*event - an event or incident that has been deemed risky/illicit
\nA list of risky events, each with a risk_type and a unique risk_name. The risk_name will be the specific event identifier that can help provide more context to the risky event, while the risk_type is a general categorization of the type of event it is classified under.
\n\n\n\n| Field | \nType | \nDescription | \n
\n\n\n\n| risk_type | \nstring | \nThe type of risk for this risk event. | \n
\n\n| risk_name | \nstring | \nThe name of the risk. | \n
\n\n| confidence | \nnumber | \nThe confidence for this risk event. | \n
\n\n| proximities | \nstring[]
origin, direct, indirect | \nThe exposure proximities that are applicable for this risk event. This can be filtered by the exposure_limit parameter. | \n
\n\n| sources | \nstring[] | \nThe list of source for this risk event.
The 2 most common sources will be: CertiK Investigations and OSINT . For other sources it will be in the format of other - {source} | \n
\n\n| risk_asset_flow_summary | \nRiskAssetFlowSummary[] | \nA list of RiskAssetFlowSummary for this risk event. This will provide incoming and outgoing flows for USD, Native and Major Top Tokens. | \n
\n\n
\n
RiskExposure
\nThe risk_exposure object will return information including a counterparty - an address that is the first point of exposure, the txn hash, the fund_direction and the amount of funds that have flown in that direction.
\n\n\n\n| Field | \nType | \nDescription | \n
\n\n\n\n| page | \nnumber | \nPage of risk exposures.
Starts at 1. | \n
\n\n| per_page | \nnumber | \nMaximum number of risk exposures to receive per page. | \n
\n\n| data | \nRiskExposureData[] | \nA list of RiskExposureData. | \n
\n\n
\n
RiskExposureData
\n\n\n\n| Field | \nType | \nDescription | \n
\n\n\n\n| risk_type | \nstring | \nThe type of risk for this risk exposure. | \n
\n\n| risk_name | \nstring | \nThe name of the risk. | \n
\n\n| txn | \nstring | \nTxn hash for this risk exposure. | \n
\n\n| usd_amount | \nnumber | \nHistorical USD value of the token_amount | \n
\n\n| token_amount | \nnumber | \nThe amount of dirty money transferred through this risk exposure. | \n
\n\n| token_address | \nstring | \nNative token (ex: ETH) or the address of the Major Top Token. | \n
\n\n| timestamp | \nnumber | \nunix timestamp, e.g. 1650782869 | \n
\n\n| counterparty | \nstring | \nThe address of the first address for this risk exposure. | \n
\n\n| proximity | \nstring | \nThe exposure proximity of this risk exposure. | \n
\n\n| fund_direction | \nstring
incoming outgoing | \nThe direction of the funds. | \n
\n\n
\n
To get a risk assesment for an on-chain address, based on customized risk rules.
\nParameter
\n\n- For detail
minimal or detailed \n
\n\n\n\n| Parameter | \nType | \nDescription | \n
\n\n\n\n| chain | \nstring | \nThe chain of the address.
Supporting the following chains: eth, bsc, btc, polygon, avax, arbitrum-one, tron, optimism, wemix, play, tornado, and multi-chain.
Lite supporting the following chains: kava, gnosis, cronos, celo, base, bch, ltc, arbitrum-nova, pulsechain, manta, ronin, mantle, hedera, zksync. | \n
\n\n| address | \nstring | \ne.g. 0x098b716b8aaf21512996dc57eb0615e2383e2f96 | \n
\n\n| exposure_limit | \nstring | \nSensitivity of the risk exposures, e.g. origin, direct, indirect | \n
\n\n| detail(Optional) | \nstring | \nLevel of detail to return in the risk response, e.g. minimal, detailed
Default is minimal | \n
\n\n| risk_types(Optional) | \nstring | \nThe types of risks to receive summarized information from, in the format of a comma separated string, e.g. sanction, hack
Supporting the following types: rugpull_exit_scam, hack, ransomware, flashloan_exploiter, scam, phishing, exploitation, honeypot, sanction, mixer, industry_blocklist, terrorism, darknet, etc. | \n
\n\n| start_timestamp(Optional) | \nnumber | \nunix timestamp, e.g. 1650782869 | \n
\n\n| end_timestamp(Optional) | \nnumber | \nunix timestamp, e.g. 1650782869 | \n
\n\n| min_usd_amount(Optional) | \nnumber | \nThe min usd amount of the fund in a summarized risk. | \n
\n\n
\n
\n- For detail
comprehensive \n
\n\n\n\n| Parameter | \nType | \nDescription | \n
\n\n\n\n| chain | \nstring | \nThe chain of the address.
Supporting the following chains: eth, bsc, btc, polygon, avax, arbitrum-one, tron, optimism, wemix, play, tornado, and multi-chain.
Lite supporting the following chains: kava, gnosis, cronos, celo, base, bch, ltc, arbitrum-nova, pulsechain, manta, ronin, mantle, hedera, zksync | \n
\n\n| address | \nstring | \ne.g. 0x098b716b8aaf21512996dc57eb0615e2383e2f96 | \n
\n\n| exposure_limit | \nstring
origin, direct, indirect | \nThe sensitivity of the risk exposures. | \n
\n\n| detail(Optional) | \nstring
comprehensive | \nLevel of detail to return in the risk response.
Default is minimal | \n
\n\n| page(Optional) | \nnumber | \nThe page of risk_exposures.
Default is 1 | \n
\n\n
\n
Response
\nA high level risk score is calculated for the address. This score is a combination of a variety of factors which largely comprise of known associations with bad actors, illicit funds activity, on-chain activity patterns and security analysis.
\nThe level of detail can be specified for the response when making the request. The detailed version will provide the data sources and asset_flow_summary in risks object. The comprehensive version will provide two more objects, risk_events and risk_exposures.
\nThe response from the API will consist of the following fields.
\n\n\n\n| Field | \nType | \nDescription | \n
\n\n\n\n| address | \nstring | \nThe address that was provided. | \n
\n\n| chain | \nstring | \nThe chain of the address that was provided. | \n
\n\n| exposure_limit | \nstring | \nThe exposure limit that was provided, e.g. origin, direct, indirect | \n
\n\n| risk_score | \nnumber | \nThe risk score of the address, ranges between 0 - 100. | \n
\n\n| risks | \nRiskDescription[] | \nA list of RiskDescription associated with the address. | \n
\n\n| risk_events | \nRiskEvent[] | \nA list of RiskEvent associated with the address.
Only for comprehensive detail | \n
\n\n| risk_exposures | \nRiskExposure | \nAn object of paginated RiskExposure associated with the address.
Only for comprehensive detail | \n
\n\n
\n
RiskDescription
\nA risk description, is unique based on the risk_type field and provides a high level of description of the risks associated with a given address.
\n\n\n\n| Field | \nType | \nDescription | \n
\n\n\n\n| risk_type | \nstring | \nThe type of risk for this risk description. Each risk description will be unique by it's risk type | \n
\n\n| total_events | \nnumber | \nThe number of known events (incidents) that are associated with this risk_type | \n
\n\n| total_exposures | \nnumber | \nThe number of known exposures (transfers) that are associated with this risk_type | \n
\n\n| proximities | \nstring[]
origin, direct, indirect | \nThe exposure proximities that are applicable for this risk description. This can be filtered by the exposure_limit parameter. | \n
\n\n| sources | \nstring[] | \nThe list of source for this risk description.
The two most common sources will be: CertiK Investigations and OSINT . For other sources it will be in the format of other - {source}
Only for detailed detail | \n
\n\n| risk_asset_flow_summary | \nRiskAssetFlowSummary[] | \nList of RiskAssetFlowSummary for this risk description. This will provide incoming and outgoing flows for USD, Native and Major Top Tokens.
Only for detailed detail | \n
\n\n
\n
RiskAssetFlowSummary
\n\n\n\n| Field | \nType | \nDescription | \n
\n\n\n\n| asset | \nstring | \nAsset name, can be USD or the Native Token (ex: ETH) or the token address. | \n
\n\n| incoming_amount | \nnumber | \nAmount of risky tokens that this address has received. | \n
\n\n| outgoing_amount | \nnumber | \nAmount of risky tokens that this address has sent. | \n
\n\n| incoming_usd_amount | \nnumber | \nHistorical USD conversion/amount of the risky tokens that the address has received. | \n
\n\n| outgoing_usd_amount | \nnumber | \nHistorical USD conversion/amount of the risky tokens that the address has sent. | \n
\n\n
\n
*USD pricing of tokens is based on historical prices and is a close estimate.
\nRiskEvent
\n*event - an event or incident that has been deemed risky/illicit
\nA list of risky events, each with a risk_type and a unique risk_name. The risk_name will be the specific event identifier that can help provide more context to the risky event, while the risk_type is a general categorization of the type of event it is classified under.
\n\n\n\n| Field | \nType | \nDescription | \n
\n\n\n\n| risk_type | \nstring | \nThe type of risk for this risk event. | \n
\n\n| risk_name | \nstring | \nThe name of the risk. | \n
\n\n| confidence | \nnumber | \nThe confidence for this risk event. | \n
\n\n| proximities | \nstring[]
origin, direct, indirect | \nThe exposure proximities that are applicable for this risk event. This can be filtered by the exposure_limit parameter. | \n
\n\n| sources | \nstring[] | \nThe list of source for this risk event.
The 2 most common sources will be: CertiK Investigations and OSINT . For other sources it will be in the format of other - {source} | \n
\n\n| risk_asset_flow_summary | \nRiskAssetFlowSummary[] | \nList of RiskAssetFlowSummary for this risk event. This will provide incoming and outgoing flows for USD, Native and Major Top Tokens. | \n
\n\n
\n
RiskExposure
\nThe risk_exposure object will return information including a counterparty - an address that is the first point of exposure, the txn hash, the fund_direction and the amount of funds that have flown in that direction.
\n\n\n\n| Field | \nType | \nDescription | \n
\n\n\n\n| page | \nnumber | \nPage of risk exposures.
Starts at 1. | \n
\n\n| per_page | \nnumber | \nMaximum number of risk exposures to receive per page. | \n
\n\n| data | \nRiskExposureData[] | \nA list of RiskExposureData. | \n
\n\n
\n
RiskExposureData
\n\n\n\n| Field | \nType | \nDescription | \n
\n\n\n\n| risk_type | \nstring | \nThe type of risk for this risk exposure. | \n
\n\n| risk_name | \nstring | \nThe name of the risk. | \n
\n\n| txn | \nstring | \nTxn hash for this risk exposure. | \n
\n\n| usd_amount | \nnumber | \nHistorical USD value of the token_amount | \n
\n\n| token_amount | \nnumber | \nThe amount of dirty money transferred through this risk exposure. | \n
\n\n| token_address | \nstring | \nNative token (ex: ETH) or the address of the Major Top Token. | \n
\n\n| timestamp | \nnumber | \nunix timestamp, e.g. 1650782869 | \n
\n\n| counterparty | \nstring | \nThe address of the first address for this risk exposure. | \n
\n\n| proximity | \nstring | \nThe exposure proximity of this risk exposure. | \n
\n\n| fund_direction | \nstring
incoming outgoing | \nThe direction of the funds. | \n
\n\n
\n
Provides the level of risks for a given address and its known security and illicit activity/funds exposures.
\n","_postman_id":"92ca319c-c088-4843-a24c-ab3be1a35af6","auth":{"type":"apikey","apikey":{"value":"{{tenant-api-key}}","key":""},"isInherited":true,"source":{"_postman_id":"3a930aba-c901-47c9-b7ea-be7b8883f8b1","id":"3a930aba-c901-47c9-b7ea-be7b8883f8b1","name":"SkyInsights API V3","type":"collection"}}},{"name":"KYT","item":[{"name":"v3/kyt/risk","id":"47b2515c-3ea2-4be9-8448-d128c8dcc3aa","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[],"url":"https://api.skyinsights.certik.com/v3/kyt/risk","description":"To check whether a transaction participates in malicious events or expose addresses to risk.
\nParameter
\n\n\n\n| Parameter | \nType | \nDescription | \n
\n\n\n\n| chain | \nstring | \nThe chain of the txn hash. | \n
\n\n| txnHash | \nstring | \nTxn hash, eg. 0xdac17f958d2ee523a2206206994597c13d831ec7 | \n
\n\n
\n
Response
\n\n\n\n| Field | \nType | \nDescription | \n
\n\n\n\n| risk_score | \nnumber | \nOverall risk score for the transaction. | \n
\n\n| risks | \nRisk[] | \nA list of of Risk object | \n
\n\n
\n
Risk
\n\n\n\n| Field | \nType | \nDescription | \n
\n\n\n\n| id | \nstring | \nUnique id for the risk. | \n
\n\n| timestamp | \nnumber | \nTime when the alert generated. | \n
\n\n| address | \nstring | \nAddress exposed to risks. | \n
\n\n| chain | \nstring | \nChain of the txn hash. | \n
\n\n| severity | \nstring | \nSeverity of the risk exposure. | \n
\n\n| rule_name | \nstring | \nRisks rule name. | \n
\n\n| txn_at | \nnumber | \nActual time when the transaction took place. | \n
\n\n| risk_exposure | \nobject | \nA RiskExposure object of transfer details and exposure details. | \n
\n\n
\n
RiskExposure
\n\n\n\n| Field | \nType | \nDescription | \n
\n\n\n\n| risk_types | \nstring[] | \nThe type of risk for this risk event. | \n
\n\n| risk_names | \nstring[] | \nThe name of the risk. | \n
\n\n| proximitiy | \nstring
direct, indirect | \nThe exposure proximity of this risk exposure. | \n
\n\n| counterparty | \nobject | \nThe counterparty address in the transaction | \n
\n\n| txn | \nobject | \nTransaction hash. | \n
\n\n| usd_amount | \nnumber | \nHistorical USD value of the token_amount | \n
\n\n| token_address | \nstring | \nToken transfered in the transaction | \n
\n\n| token_amount | \nnumber | \nThe amount of dirty money transferred through this risk exposure. | \n
\n\n| src_address | \nstring | \nBad acting address | \n
\n\n| inflow | \nnumber | \nUSD value inflow to target address | \n
\n\n| outflow | \nnumber | \nUSD value outflow from target address | \n
\n\n| hop | \nnumber | \nNumber of transaction hops between target address and bad acting address | \n
\n\n
\n
To check whether a transaction will trigger certain alerts, based on customized alert rules.
\nTarget addresses are defined by cusomer entity.
\nParameter
\n\n\n\n| Parameter | \nType | \nDescription | \n
\n\n\n\n| chain | \nstring | \nThe chain of the txn hash. | \n
\n\n| txnHash | \nstring | \nTxn hash, eg. 0xdac17f958d2ee523a2206206994597c13d831ec7 | \n
\n\n| customer_id | \nstring | \nCustomer id for the customer entity. | \n
\n\n
\n
Response
\nWith customer_id , this API will find the corresponding addresses and alert rules for the target customer entity. And alert will be triggered, if the transaction expose any address to any risk defined in alert rules.
\nTransactionAlert
\nAn array of TransactionAlert object for this transaction.
\n\n\n\n| Field | \nType | \nDescription | \n
\n\n\n\n| id | \nstring | \nUnique id for the alert. | \n
\n\n| chain | \nstring | \nchain | \n
\n\n| address | \nstring | \nThe target address that expose to risk | \n
\n\n| timestamp | \nnumber | \nThe unix timestamp(ms) this transaction take place on chain | \n
\n\n| severity | \nstring | \nSeverity level of the alert rule defined by user: medium, high, very_high | \n
\n\n| rule_name | \nstring | \nAlert rule name | \n
\n\n| rule_group_id | \nstring | \nUser defiend id for the rule group | \n
\n\n| rule_group_name | \nstring | \nRule group name | \n
\n\n| monitoring_group_id | \nstring | \nUser defined id for the monitoring group | \n
\n\n| monitoring_group_name | \nstring | \nMonitoring group name | \n
\n\n| risk_exposure | \nRiskExposure | \nA RiskExposure object of transfer details and exposure details | \n
\n\n
\n
RiskExposure
\nThe risk_exposure object will return detailed information of this alert.
\n\n\n\n| Field | \nType | \nDescription | \n
\n\n\n\n| risk_types | \nstring[] | \nThe type of risk for this risk event. | \n
\n\n| risk_names | \nstring[] | \nThe name of the risk. | \n
\n\n| proximitiy | \nstring | \nThe exposure proximity of this risk exposure, e.g. direct, indirect | \n
\n\n| counterparty | \nstring | \nThe counterparty address in the transaction | \n
\n\n| txn | \nstring | \nTransaction hash. | \n
\n\n| usd_amount | \nnumber | \nHistorical USD value of the token_amount | \n
\n\n| token_address | \nstring | \nToken transfered in the transaction | \n
\n\n| token_amount | \nnumber | \nThe amount of dirty money transferred through this risk exposure. | \n
\n\n| src_address | \nstring | \nBad acting address | \n
\n\n| inflow | \nnumber | \nUSD value inflow to target address | \n
\n\n| outflow | \nnumber | \nUSD value outflow from target address | \n
\n\n| hop | \nnumber | \nNumber of transaction hop between target address and bad acting address | \n
\n\n
\n
The endpoint allows users to retrieve alerts genereted from both active screening and real-time monitor.
\nParameter
\n\n\n\n| Parameter | \nType | \nDescription | \n
\n\n\n\n| page(Optional) | \nnumber | \nSpecifies the page number of the results to retrieve | \n
\n\n| limit(Optional) | \nnumber | \nPlaces a limit on the number of returned results | \n
\n\n| monitoring_group_id(Optional) | \nstring | \nUser defined monitoring group id | \n
\n\n| severity(Optional) | \nstring | \nSeverity level of the alert rule defined by user: medium, high, very_high. | \n
\n\n| risk_type(Optional) | \nstring | \nRisk types of the alert rule defined by user: ATM,Bridge,CSAM,Darknet,Exploitation,Fraud_shop,Gambling,Hack,High_Risk_Exchanges,Illegal_Service,Mixer,P2P,Phishing,Ransomware,Sanctioned,Scam,Terrorism | \n
\n\n| start_timestamp(Optional) | \nnumber | \n | \n
\n\n| end_timestamp(Optional) | \nnumber | \n | \n
\n\n
\n
Response
\n\n\n\n| Field | \nType | \nDescription | \n
\n\n\n\n| alerts | \nAlert[] | \nA list of Alert object for this transaction. | \n
\n\n| has_more | \nboolean | \nWhether there are more alerts matching the filter conditions. If so, you can query the next page. | \n
\n\n
\n
Alert
\n\n\n\n| Field | \nType | \nDescription | \n
\n\n\n\n| id | \nstring | \nUnique id for the alert. | \n
\n\n| tenant_id | \nstring | \nThe tenant id | \n
\n\n| chain | \nstring | \nchain | \n
\n\n| chain_address | \nstring | \nThe target address that was exposed to risk | \n
\n\n| timestamp | \nnumber | \nThe unix timestamp(ms) this transaction take place on chain | \n
\n\n| severity | \nstring | \nSeverity level of the alert rule defined by user: medium, high, very_high | \n
\n\n| config_id | \nstring | \nAlert rule id. | \n
\n\n| risk_types | \nstring[] | \nA list of general risks. | \n
\n\n| action_status | \nstring | \nAction status, e.g. open, under_review, dismissed, escalated_to_investigation_case | \n
\n\n| monitoring_group_id | \nstring | \nA user defined id for the monitoring group. | \n
\n\n| txn_at | \nnumber | \nTimestamp of the transaction. | \n
\n\n| risk_exposure | \nRiskAlertDetails | \nRisk alert details | \n
\n\n| modified_at | \nnumber | \nThe last timestamp the action status changed. | \n
\n\n
\n
RiskAlertDetails
\n\n\n\n| Field | \nType | \nDescription | \n
\n\n\n\n| txn_hash | \nstring | \nTransaction hash | \n
\n\n| token | \nstring | \nNative token (ex: ETH) | \n
\n\n| price | \nnumber | \nThe token price | \n
\n\n| decimal | \nnumber | \n | \n
\n\n| type | \nstring | \n | \n
\n\n| inflow | \nnumber | \nUSD value inflow to target address | \n
\n\n| outflow | \nnumber | \nUSD value outflow from target address | \n
\n\n| target_address_type | \nstring | \nThe type of target address | \n
\n\n| counterparty_address | \nstring | \nThe address of the first address for this risk exposure. | \n
\n\n| src_address | \nstring | \nBad acting address | \n
\n\n| path_addresses | \nstring[] | \nList of addresses in the transaction | \n
\n\n| path_txns | \nstring[] | \nList of addresses in the transaction hash | \n
\n\n| prevuuid | \nstring | \nPrevious uuid | \n
\n\n| hop | \nnumber | \nNumber of transaction hop between target address and bad acting address | \n
\n\n| uuid | \nstring | \nUnique id for the transaction | \n
\n\n| amount | \nnumber | \nThe amount of dirty money transferred through this risk exposure. | \n
\n\n| usd_value | \nnumber | \nHistorical USD value of the token_amount | \n
\n\n| labels | \nstring | \nStringified label map json | \n
\n\n| direction | \nstring | \nTransaction direction | \n
\n\n| src_addresslabels | \nAddressLabels[] | \nSource address labels | \n
\n\n
\n
Stringified label
\nStringified label map json is a JSON string, with key as risk type, and value as addressInfo with risk type.
\n{\n \"Mixer\": {\n \"ADDRESS\": \"eth:0xd90e2f925da726b50c4ed8d0fb90ad053324f31b\",\n \"ADDRESS_TYPE\": \"verified contract\",\n \"CHAIN\": \"eth\",\n \"CONFIDENCE_LEVEL\": 100,\n \"GENERAL\": \"Mixer\",\n \"ID\": 5443484,\n \"INSERTED_DATE\": 1698990997,\n \"LABEL_SOURCE\": \"manual_input:ofac_sdn\",\n \"NAME\": \"OFAC's Sanction List\",\n \"RISKTYPE\": \"Mixer\",\n \"RISKTYPE_UPDATE_TIMESTAMP\": 1712186153,\n \"SUBTYPE\": \"Tornado_Cash\",\n \"TIMESTAMP\": 1659916800,\n \"UPDATE_TIMESTAMP\": 1713161353,\n \"UUID\": \"9f5ade4e-f02a-4de6-885b-3371615b8ea3\"\n },\n \"Sanctioned\": {\n \"ADDRESS\": \"eth:0xd90e2f925da726b50c4ed8d0fb90ad053324f31b\",\n \"ADDRESS_TYPE\": \"verified contract\",\n \"CHAIN\": \"eth\",\n \"CONFIDENCE_LEVEL\": 100,\n \"GENERAL\": \"Sanctioned\",\n \"ID\": 5443484,\n \"INSERTED_DATE\": 1713159369,\n \"LABEL_SOURCE\": \"manual_input:ofac_sdn\",\n \"NAME\": \"OFAC:TORNADO CASH\",\n \"RISKTYPE\": \"Sanctioned\",\n \"RISKTYPE_UPDATE_TIMESTAMP\": 1712186153,\n \"SUBTYPE\": \"Sanctioned\",\n \"TIMESTAMP\": 1669852800,\n \"UPDATE_TIMESTAMP\": 1713161353,\n \"UUID\": \"c93fc252-c8a7-4802-81f8-4d42e96bffa1\"\n }\n}\n\n
\n\n\n| Field | \nType | \nDescription | \n
\n\n\n\n| {risk_type} | \nstring | \nThe type of risk for this risk exposure, eg. Mixer, Sanctioned | \n
\n\n| ADDRESS | \nstring | \nThe name of the risk | \n
\n\n| ADDRESS_TYPE | \nstring | \nThe address type | \n
\n\n| CHAIN | \nstring | \nThe chain of the address. | \n
\n\n| CONFIDENCE_LEVEL | \nstring | \nThe level of confidence | \n
\n\n| GENERAL | \nstring | \nThe general name | \n
\n\n| ID | \nstring | \nThe unique id | \n
\n\n| INSERTED_DATE | \nnumber | \nThe unix timestamp, e.g. 1659916800 | \n
\n\n| LABEL_SOURCE | \nstring | \nLabel source, e.g. manual_input:ofac_sdn | \n
\n\n| NAME | \nstring | \nThe risk entity name | \n
\n\n| RISKTYPE | \nstring | \nThe type of risk for this risk exposure, eg. Mixer, Sanctioned | \n
\n\n| RISKTYPE_UPDATE_TIMESTAMP | \nnumber | \nThe unix timestamp, e.g. 1659916800 | \n
\n\n| SUBTYPE | \nstring | \nThe risk entity subtype | \n
\n\n| TIMESTAMP | \nstring | \nThe unix timestamp, e.g. 1659916800 | \n
\n\n| UPDATE_TIMESTAMP | \nstring | \nThe unix timestamp, e.g. 1659916800 | \n
\n\n| UUID | \nstring | \nThe unique id | \n
\n\n
\n
AddressLabels
\n\n\n\n| Field | \nType | \nDescription | \n
\n\n\n\n| risk_type | \nstring | \nThe type of risk for this risk exposure | \n
\n\n| risk_name | \nstring | \nThe name of the risk | \n
\n\n| timestamp | \nnumber | \nunix timestamp, e.g. 1650782869 | \n
\n\n| label_source | \nstring | \nLabel source, e.g. CertiK Investigations | \n
\n\n
\n
Retrieve all monitoring groups for the tenant.
\nResponse
\n\n\n\n| Field | \nType | \nDescription | \n
\n\n\n\n| id | \nstring | \nUnique id for the monitoring group | \n
\n\n| name | \nstring | \nThe monitoring group's name | \n
\n\n| created_at | \nnumber | \nThe unix timestamp(ms) of the monitoring group was created | \n
\n\n| description | \nstring | \nThe description of this monitoring group | \n
\n\n
\n
The endpoint allows users to import address to a monitoring group.
\nParameter
\n\n\n\n| Parameter | \nType | \nDescription | \n
\n\n\n\n| monitoring_group_id | \nnumber | \nUnique id for the monitoring group. | \n
\n\n| addresses | \nstring[] | \nThe chain addresses that were import to monitoring group | \n
\n\n
\n
Response
\n\n\n\n| Field | \nType | \nDescription | \n
\n\n\n\n| message | \nstring | \nThe result message (success/failed). | \n
\n\n| successful_addition_count | \nnumber | \nNumber of successfully added chain addresses | \n
\n\n| skipped_addresses | \nSkipedAddress[] | \nList of addresses that were not added due to duplication | \n
\n\n
\n
SkipedAddress
\n\n\n\n| Field | \nType | \nDescription | \n
\n\n\n\n| chain_address | \nstring | \nThe chain addresses that was not added | \n
\n\n| entity_external_id | \nstring | \nThe external entity id associated with this address | \n
\n\n| entity_id | \nstring | \nThe external entity id associated with this address | \n
\n\n| monitoring_group_id | \nstring | \nThe monitoring group id associated with this address | \n
\n\n
\n
Transaction screening service.
\n","_postman_id":"2f463f2f-1527-4976-9363-9b5afd8f51cf","auth":{"type":"apikey","apikey":{"value":"{{tenant-api-key}}","key":""},"isInherited":true,"source":{"_postman_id":"3a930aba-c901-47c9-b7ea-be7b8883f8b1","id":"3a930aba-c901-47c9-b7ea-be7b8883f8b1","name":"SkyInsights API V3","type":"collection"}}}],"auth":{"type":"apikey","apikey":{"value":"{{tenant-api-key}}","key":""}},"event":[{"listen":"prerequest","script":{"id":"ca8b2b59-7b61-4efb-ba8d-0f0ee36a3a06","type":"text/javascript","exec":[""]}},{"listen":"test","script":{"id":"c7cabc3d-f463-49d5-bf26-93917c8651d0","type":"text/javascript","exec":[""]}}],"variable":[{"value":"","disabled":true}]}