This section contains methods for assessing the risk of transactions and addresses on the blockchain using the Elliptic service.
The methods allow you to check the reliability of incoming and outgoing transactions, identify suspicious activities, and categorize risks.
You can also obtain detailed reports on counterparties, their shares, amounts, and connections between addresses.
This information helps partners make compliance decisions, prevent fraud.
Documentation
Simplified AML Report
This method returns a simplified risk assessment for a specific blockchain address using the various AML services. The response includes two fields: passed and completed.
The completed key indicates whether our compliance system completed the risk assessment — sometimes, information received from AML providers can be incomplete or inadequate for our risk checkers. This is the first key you should check — passed will never be true if completed is false.
In turn, the passed key indicates whether the provided address passed our risk checks. A suspicious address will always have "passed": false in the API response, but only if completed is set to true.
HTTP Request
Method: GET URL: /api/v2/compliance/elliptic/address-report
Request Example:
curl -X 'GET' \ 'https://dxspot.io/api/v2/compliance/elliptic/address-report?address=some_address' \ -H 'accept: application/json' \ -H 'X-Api-Public-Key: {YOUR_PUBLIC_KEY}' \ -H 'X-Api-Timestamp: {UNIX_MS_TIMESTAMP}' \ -H 'X-Api-Signature: {SIGNATURE}' \
Request Parameters
All parameters are passed in the query string.
Query Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| address | string | Yes | Wallet address to check. |
Example Response
{ "completed": true, "passed": true }
Response Fields
| Field | Type | Description |
|---|---|---|
| completed | boolean | Indicates whether the compliance system completed the risk assessment. If false, the result is not final and passed will never be true. |
| passed | boolean | Indicates whether the address passed the risk checks. If the address is suspicious, this will be false (only meaningful when completed is true). |
Code Sample
curl -X 'GET' \
'https://dxspot.io/api/v2/compliance/elliptic/address-report?address=TNjkHpHwV8MWT9jffLmMpHNt3Da1VFAqWY' \
-H 'accept: application/json' \
-H 'X-Api-Public-Key: {YOUR_PUBLIC_KEY}' \
-H 'X-Api-Timestamp: {UNIX_MS_TIMESTAMP}' \
-H 'X-Api-Signature: {SIGNATURE}' \Response Example
{
"riskScore": 9.22690254307772,
"type": "ADDRESS",
"evaluationDetailsSource": [
{
"rule_id": "cf0ca4c8-4783-4d88-8772-424e7a511f0b",
"rule_name": "Exchange_Legal",
"rule_type": "exposure",
"risk_score": 9.22690254307772,
"matched_behaviors": [],
"matched_elements": [
{
"counterparty_percentage": 71.34044036074452,
"counterparty_value": {"usd": 86217.78721520543},
"category_id": "0a52f7a2-5da8-4256-b230-df0da6f8449b",
"contribution_value": {"usd": 120854.01601003749},
"indirect_percentage": 28.659559639255473,
"indirect_value": {"usd": 34636.22879483205},
"category": "Exchange",
"contributions": [
{
"counterparty_percentage": 33.5451643812689,
"counterparty_value": {"usd": 43943.88714642392},
"is_screened_address": false,
"contribution_value": {"usd": 63142.383413071},
"indirect_percentage": 14.655433123986867,
"min_number_of_hops": 1,
"indirect_value": {"usd": 19198.496266647082},
"risk_triggers": {"category_id": "0a52f7a2-5da8-4256-b230-d", "category": "Exchange"},
"contribution_percentage": 48.200597505255764,
"entity": "KuCoin"
}
],
"contribution_percentage": 92.25555748324315
}
]
}
],
"evaluationDetailsDestination": [
{
"rule_id": "cf0ca4c8-4783-4d88-8772-424e7a511f0b",
"rule_name": "Exchange_Legal",
"rule_type": "exposure",
"risk_score": 6.919504458834783,
"matched_behaviors": [],
"matched_elements": [
{
"counterparty_percentage": 34.39473797491202,
"counterparty_value": {"usd": 27249.80997933003},
"category_id": "0a52f7a2-5da8-4256-b230-df0da",
"contribution_value": {"usd": 79226.68286993902},
"indirect_percentage": 65.60526202508797,
"indirect_value": {"usd": 51976.87289060898},
"category": "Exchange",
"contribution_percentage": 69.19504458834783,
"contributions": [
{
"counterparty_percentage": 12.3108208,
"counterparty_value": {"usd": 14095.597352678127},
"is_screened_address": false,
"contribution_value": {"usd": 31761.48155214954},
"indirect_percentage": 15.42903968840,
"min_number_of_hops": 1,
"indirect_value": {"usd": 17665.884199471413},
"risk_triggers": {"category_id": "0a52f7a2-5da8-425", "category": "Exchange"},
"contribution_percentage": 27.7398605,
"entity": "Bybit"
}
]
}
]
}
]
}Try it out
Leave empty to use default
Query Parameters
Headers
Documentation
Transaction report
This method returns a simplified AML risk assessment for a specific transaction (txHash) in the context of a destination address (depositAddress). The response includes two fields: completed and passed.
Important: Always check completed first. If completed is false, the assessment is not final and passed will never be true.
HTTP Request
Method: GET
URL: /api/v2/compliance/elliptic/tx-report
Request Example:
GET /api/v2/compliance/elliptic/tx-report?depositAddress=some_address&txHash=some_tx_hash
Request Parameters
All parameters are passed in the query string.
Query Parameters
| Parameter | Type | Required | Description |
|---|---|---|---|
| txHash | string | Yes | Transaction hash to check. |
| depositAddress | string | Yes | Wallet address that was the destination of the provided transaction. |
Examples
Transaction / Address check incomplete, no results can be obtained
{ "completed": false, "passed": false }
Transaction / Address check complete, AML checks not passed due to suspicious activity
{ "completed": true, "passed": false }
Transaction / Address check complete, AML checks passed
{ "completed": true, "passed": true }
Response Fields
| Field | Type | Description |
|---|---|---|
| completed | boolean | Indicates whether the compliance system completed the risk assessment. If false, the result is not final. |
| passed | boolean | Indicates whether the transaction/address passed the AML risk checks. Meaningful only when completed is true. |
Code Sample
curl -X GET \
'https://dxspot.io/api/v2/compliance/elliptic/tx-report?txHash=YOUR_TX_HASH&depositAddress=YOUR_DEPOSIT_ADDRESS' \
-H 'accept: application/json' \
-H 'X-Api-Public-Key: {YOUR_PUBLIC_KEY}' \
-H 'X-Api-Timestamp: {UNIX_MS_TIMESTAMP}' \
-H 'X-Api-Signature: {SIGNATURE}'
Response Example
{
"riskScore": 9.22690254307772,
"type": "TRANSACTION",
"evaluationDetails": [
{
"rule_id": "cf0ca4c8-4783-4d88-8772-424e7a511f0b",
"rule_type": "exposure",
"risk_score": 9.22690254307772,
"rule_name": "Exchange_Legal",
"rule_history_id": "15955715-e0bd-4262-83b9-2327a9e9d5b4",
"matched_behaviors": [],
"matched_elements": [
{
"counterparty_percentage": 71.34044036074455,
"counterparty_value": { "usd": 2962.3109641631327 },
"category_id": "0a52f7a2-5da8-4256-b230-df0da6f8449b",
"contribution_value": { "usd": 4152.358675084882 },
"indirect_percentage": 28.659559639255487,
"indirect_value": { "usd": 1190.0477109217506 },
"contributions": [
{
"counterparty_percentage": 33.5451643812689,
"counterparty_value": { "usd": 1509.844579713838 }
}
],
"is_screened_address": false,
"min_number_of_hops": 1,
"risk_triggers": {
"category_id": "0a52f7a2-5da8-4256-b230-d",
"category": "Exchange"
},
"entity": "KuCoin",
"contribution_percentage": 48.200597505255764
}
],
"category": "Exchange",
"contribution_percentage": 92.25555748324315
}
]
}Try it out
Leave empty to use default
Query Parameters
Blockchain transaction hash to be checked.
Destination address where the funds were received (deposit address).