Get Detailed Report

Detailed report by ID of a specific request

get https://api.cryptomus.com/v2/user-api/aml/check/request/{id} Copy

Request

Request parameters

NameParameter typeDefinition
id*integerUnique request identifierURL parameter

Parameter type

integer

Definition

Unique request identifierURL parameter

* - mandatory parameter

Request example


curl https://api.cryptomus.com/v2/user-api/aml/check/request/123 \
-X GET \
-H 'userId: 8b03432e-385b-4670-8d06-064591096795' \
-H 'sign: fe99035f86fa436181717b302b95bacff1' \
-H 'Content-Type: application/json'
Copy

Response

Response parameters

NameParameter typeDefinition
idintegerUnique request identifier
network_codestring|nullRequest network code (btc, eth, bsc...)
typestringAvailable values• address• transactionaddress or txid
addressstring|nullAddress being checked
txidstring|nullTransaction hash
statestringAvailable values• pending• completed• failedStatus: pending, completed, failed
riskobject|nullRisk assessment result
risk.scoreintegerRisk score
risk.levelstringRisk level
risk.colorstringRisk color
pdf_reportstring|nullPDF URL (null if not generated)
completed_atstring|nullCompletion date and time
reportobject|nullReport data
report.timestampintegerReport timestamp
report.memostringReport memo
report.blacklistbooleanBlacklist flag
report.signalsobjectReport signals
report.address_detailsAddress details
report.directionstringDirection
report.amountAmount
report.tokenToken
report.tagsTags

Parameter type

integer

Definition

Unique request identifier

Parameter type

string|null

Definition

Request network code (btc, eth, bsc...)

Parameter type

string
Available values
- address- transaction

Definition

address or txid

Parameter type

string|null

Definition

Address being checked

Parameter type

string|null

Definition

Transaction hash

Parameter type

string
Available values
- pending- completed- failed

Definition

Status: pending, completed, failed

Parameter type

object|null

Definition

Risk assessment result

Parameter type

integer

Definition

Risk score

Parameter type

string

Definition

Risk level

Parameter type

string

Definition

Risk color

Parameter type

string|null

Definition

PDF URL (null if not generated)

Parameter type

string|null

Definition

Completion date and time

Parameter type

object|null

Definition

Report data

Parameter type

integer

Definition

Report timestamp

Parameter type

string

Definition

Report memo

Parameter type

boolean

Definition

Blacklist flag

Parameter type

object

Definition

Report signals

Definition

Address details

Parameter type

string

Definition

Direction

Definition

Amount

Definition

Token

Definition

Tags

Response example


1{
2  "state": 0,
3  "result": {
4      "id": 123,
5      "network_code": "tron",
6      "type": "address",
7      "address": "TXYZabc...",
8      "txid": null,
9      "state": "completed",
10      "risk": {
11          "score": 10,
12          "level": "low",
13          "color": "#22C55E"
14      },
15      "pdf_report": "https://...",
16      "completed_at": "2025-07-16T14:12:08+00:00",
17      "report": {
18          "timestamp": 1721139128,
19          "memo": null,
20          "blacklist": false,
21          "signals": {},
22          "address_details": {
23              "balance": {
24                  "decimal": 6,
25                  "approximate": "100.5",
26                  "tokens": []
27              },
28              "transactions_count": 12
29          },
30          "direction": "incoming",
31          "amount": {
32              "value": "15.00",
33              "currency": {
34                  "code": "USDT"
35              }
36          },
37          "token": {
38              "contract": null,
39              "code": "USDT",
40              "decimal": 6
41          },
42          "tags": []
43      }
44  }
45}
Copy