正式环境url: https://detrust.bitrace.io
沙盒环境url: https://detrust-sandbox.bitrace.cn
api密钥创建和使用
1.登录detrust
2.选择个人设置
3.创建密钥,创建成功后请保存密钥
KYT API使用唯一的api令牌授权调用
请在请求中传递heaer:
apiKey:{apiKey}
apiSecret:{apiSecret}
如果身份验证失败,您将收到包含错误消息和 业务状态码 60006 的 JSON 响应。
所有数据均以 JSON 格式发送和接收,但 API 密钥(令牌)除外,它作为标头发送。对于所有其他请求,您应该在请求标头中使用Content-type: application/json或。Accept: application/json包含空白字段而null不是省略。
时间戳为 UTC
KYT 使用标准 HTTP 响应代码来指示 API 请求的成功或失败。
代码 | 意义 | 描述 |
---|---|---|
200 | 请求成功 | 请求成功 |
400 | 错误的请求 | 该请求是不可接受的 |
500 | 内部服务器错误 | 服务不可用 |
表示接口请求成功,返回业务错误码
eg: {"success":false,"code":60006,"msg":"api.key.is.error","data":null}
代码 | 意义 | 描述 |
---|---|---|
1 | 成功 | 请求成功 |
60000 | 不支持 | 表示该主网暂不支持 |
60001 | 不支持 | 表示该币种暂不支持 |
60002 | 参数错误 | 表示hash值错误 |
60004 | 查询不存在 | 表示查询的external_id 不存在 |
60005 | 错误 | 表示地址错误 |
60006 | apiKey错误 | apiKey 错误 |
category | categoryId |
---|---|
交易所 | exchange |
网赌 | online_gambling |
洗钱 | money_laundering |
黑灰产 | cinereus |
欺诈 | swindle |
Path:/api/kyt/users/{userId}/withdrawal-attempts
Method:POST
接口描述:
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
Content-Type | application/json | 是 | application/json |
路径参数
参数名称 | 示例 | 备注 |
---|---|---|
userId | 标识与此提款尝试关联的用户的唯一字符串 |
Body
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
network | string | 必须 | 此提款尝试发生的区块链网络。注:目前仅支持tron、ethereum | ||
asset | string | 必须 | 币种符号 | ||
address | string | 必须 | 尝试提款的钱包的加密货币地址 | ||
attemptIdentifier | string | 必须 | 标识此提款尝试的唯一字符串 | ||
assetAmount | number | 必须 | 次提款尝试中使用的加密货币资金金额 | ||
assetPrice | number | 非必须 | 尝试提款时资产的美元价格。注意:如果您提供 ,则assetPrice还必须提供assetDenomination | ||
assetDenomination | string | 非必须 | 财产的面额assetPrice。仅可用作USD. 注意:如果您提供 ,assetDenomination您还必须提供assetPrice. | ||
attemptTimestamp | string | 必须 | 尝试提款时的时间戳,毫秒值 采用 UTC 时区 |
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
success | boolean | 非必须 | |||
code | integer | 非必须 | |||
msg | string | 非必须 | |||
data | object | 非必须 | |||
├─network | string | 非必须 | 主网 | ||
├─asset | string | 非必须 | 资产 | ||
├─address | string | 非必须 | address您在请求正文中定义的回显 | ||
├─attemptIdentifier | string | 非必须 | 您在请求正文中创建的标识符的回显 | ||
├─assetAmount | number | 非必须 | 请求正文中定义的资产金额的回显 | ||
├─usdAmount | number | 非必须 | 本次转账使用的美元资金金额。注意:该值null在初始 POST 请求后保持不变,直到 KYT 完成处理提款尝试为止 | ||
├─updatedAt | string | 非必须 | 上次更新提款尝试时的时间戳,采用 UTC 时区。注意:该值null在初始 POST 请求后保持不变,直到 KYT 完成处理提款尝试为止。如果null,则轮询摘要端点,直到updatedAt返回值 | ||
├─externalId | string | 非必须 | 生成的提款尝试标识符 |
Path:/api/kyt/users/{userId}/transfers
Method:POST
接口描述:
Headers
参数名称 | 参数值 | 是否必须 | 示例 | 备注 |
---|---|---|---|---|
Content-Type | application/json | 是 | application/json |
路径参数
参数名称 | 示例 | 备注 |
---|---|---|
userId |
Body
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
network | string | 必须 | 主网 | ||
asset | string | 必须 | 币种符号 | ||
transferReference | string | 必须 | 交易哈希和交易输出地址或索引的组合,用冒号分隔。例如,{transaction_hash}:{output_address}或{transaction_hash}:{output_index} | ||
direction | string | 必须 | 该值定义传输是否为sent或received。该值需小写, | ||
transferTimestamp | string | 非必须 | 传输发生时的时间戳,采用 UTC 毫秒值。时间戳应与包含交易的块的时间戳相对应 | ||
assetAmount | number | 非必须 | 本次转账使用的加密货币资金金额 | ||
outputAddress | string | 非必须 | 交易中资金的目的地地址 | ||
inputAddresses | string [] | 非必须 | 传输的输入地址列表。Chainaanalysis 使用此属性来匹配网络标识 |
item 类型: string |
|
├─ | 非必须 | ||||
assetPrice | number | 非必须 | 转移时资产的美元价格 | ||
assetDenomination | string | 非必须 | 财产的面额assetPrice。仅可用作USD |
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
success | boolean | 非必须 | |||
code | integer | 非必须 | |||
msg | string | 非必须 | |||
data | object | 非必须 | |||
├─updatedAt | string | 非必须 | 上次更新传输时的时间戳,采用 UTC ISO 8601 格式。注意:该值null在初始 POST 请求之后保持不变,直到 KYT 完成传输处理。轮询摘要端点直到updatedAt返回值 | ||
├─asset | string | 非必须 | 币种符号 | ||
├─network | string | 非必须 | 主网 | ||
├─transferReference | string | 非必须 | 您在请求正文中定义的传输引用的回显 | ||
├─tx | string | 非必须 | 转账的交易哈希。注意:该值null在初始 POST 请求之后保持不变,直到 KYT 完成传输处理 | ||
├─idx | integer | 非必须 | 传输的索引。注意:该值null在初始 POST 请求之后保持不变,直到 KYT 完成传输处理 | ||
├─usdAmount | number | 非必须 | 本次转账使用的美元资金金额。注意:该值null在初始 POST 请求之后保持不变,直到 KYT 完成传输处理 | ||
├─assetAmount | number | 非必须 | 本次转账使用的加密货币资金金额。注意:该值null在初始 POST 请求之后保持不变,直到 KYT 完成传输处理 | ||
├─timestamp | string | 非必须 | 传输发生时的时间戳,采用 UTC ISO 8601 格式。注意:该值null在初始 POST 请求之后保持不变,直到 KYT 完成传输处理 | ||
├─outputAddress | string | 非必须 | 交易中资金的目的地地址。如果 POST 请求中未提供,KYT 会从transferReference. 注意:该值null在初始 POST 请求之后保持不变,直到 KYT 完成传输处理 | ||
├─externalId | string | 非必须 | 生成的本次传输的标识符 |
Path:/api/kyt/transfers/{externalId}/exposures
Method:GET
接口描述:
路径参数
参数名称 | 示例 | 备注 |
---|---|---|
externalId | 生成的本次传输的标识符 |
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
success | boolean | 非必须 | |||
code | integer | 非必须 | |||
msg | string | 非必须 | |||
data | object | 非必须 | |||
├─direct | object [] | 非必须 |
item 类型: object |
||
├─name | string | 非必须 | 确定的给定集群交易对手的名称 | ||
├─category | string | 非必须 | 确定的给定集群交易对手的类别 | ||
├─categoryId | string | 非必须 | 实体类别的唯一标识符 |
Path:/api/kyt/transfers/{externalId}
Method:GET
接口描述:
路径参数
参数名称 | 示例 | 备注 |
---|---|---|
externalId | 生成的本次传输的标识符 |
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
success | boolean | 非必须 | |||
code | integer | 非必须 | |||
msg | string | 非必须 | |||
data | object | 非必须 | |||
├─updatedAt | string | 非必须 | 上次更新传输的时间戳,采用 UTC ISO 8601 格式。如果null,则转账尚未处理,或无法处理,因为它尚未出现在区块链中 | ||
├─asset | string | 非必须 | 币种符号 | ||
├─network | string | 非必须 | 区块网络 | ||
├─transferReference | string | 非必须 | transferReference在POST调用的请求正文中定义的 | ||
├─tx | string | 非必须 | 转账的交易哈希 | ||
├─idx | integer | 非必须 | 传输的索引。如果null,则 KYT 尚未完成传输处理,或者交易不包含索引传输 | ||
├─usdAmount | number | 非必须 | 本次转账使用的美元资金金额。如果null,则 KYT 尚未完成传输处理,或者信息未在GET请求中发送给 KYT | ||
├─assetAmount | number | 非必须 | 本次转账使用的加密货币资金金额。如果null,则 KYT 尚未完成传输处理,或者信息未在GET请求中发送给 KYT | ||
├─timestamp | string | 非必须 | 传输发生时的区块链时间戳,采用 UTC ISO 8601 格式。如果null,则 KYT 尚未完成传输处理,或者信息未在GET请求中发送给 KYT | ||
├─outputAddress | string | 非必须 | 交易中资金的目的地地址。如果null,则 KYT 尚未完成传输处理,或者信息未在GET请求中发送给 KYT | ||
├─externalId | string | 非必须 | 生成的本次传输的标识符 |
Path:/api/kyt/transfers/{externalId}/alerts
Method:GET
接口描述:
路径参数
参数名称 | 示例 | 备注 |
---|---|---|
externalId | 生成的本次传输的标识符 |
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
success | boolean | 非必须 | |||
code | integer | 非必须 | |||
msg | string | 非必须 | |||
data | object | 非必须 | |||
├─alerts | object [] | 非必须 | 包含给定传输的警报信息。如果没有生成警报,则该数组将为空 |
item 类型: object |
|
├─alertLevel | string | 非必须 | 将警报的风险定义为super_high高危、high高、medium中、low低 | ||
├─category | string | 非必须 | 警报规则正在跟踪的实体类别 | ||
├─service | string | 非必须 | 定义的服务名称 | ||
├─externalId | string | 非必须 | 警报的唯一标识 | ||
├─alertAmount | number | 非必须 | 导致触发警报的美元金额 | ||
├─exposureType | string | 非必须 | 将曝光方向定义为DIRECT或INDIRECT,注意:目前仅支持DIRECT | ||
├─categoryId | string | 非必须 | 实体类别的唯一标识符 | ||
├─strategy | object | 非必须 | 策略 | ||
├─strategy | string | 非必须 | 策略名称 | ||
├─rule | string | 非必须 | 规则名称 | ||
├─level | string | 非必须 | 预警等级 | ||
├─decisionCode | string | 非必须 | 决策树code | ||
├─decisionMarker | string | 非必须 | 决策树输出 |
Path:/api/kyt/withdrawal-attempts/{externalId}
Method:GET
接口描述:
路径参数
参数名称 | 示例 | 备注 |
---|---|---|
externalId | 生成的此提款尝试的标识符 |
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
success | boolean | 非必须 | |||
code | integer | 非必须 | |||
msg | string | 非必须 | |||
data | object | 非必须 | |||
├─network | string | 非必须 | 区块网络 | ||
├─asset | string | 非必须 | 币种符号 | ||
├─address | string | 非必须 | 尝试提款的地址 | ||
├─attemptIdentifier | string | 非必须 | attemptIdentifier您在POST请求中创建的回显 | ||
├─assetAmount | number | 非必须 | 本次提款尝试中使用的加密货币资金金额 | ||
├─usdAmount | number | 非必须 | 本次提款尝试中使用的美元金额 | ||
├─updatedAt | string | 非必须 | 上次处理提款尝试的时间戳,采用 UTC ISO 8601 格式。如果null,则提款尝试尚未处理 | ||
├─externalId | string | 非必须 | 生成的此提款尝试的标识符 |
Path:/api/kyt/withdrawal-attempts/{externalId}/exposures
Method:GET
接口描述:
路径参数
参数名称 | 示例 | 备注 |
---|---|---|
externalId | 生成的此提款尝试的标识符 |
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
success | boolean | 非必须 | |||
code | integer | 非必须 | |||
msg | string | 非必须 | |||
data | object | 非必须 | |||
├─direct | object | 非必须 | 包含给定簇的直接暴露信息 | ||
├─name | string | 非必须 | 确定的给定集群交易对手的名称 | ||
├─category | string | 非必须 | 确定的给定集群交易对手的类别 | ||
├─categoryId | string | 非必须 | 实体类别的唯一标识符 |
Path:/api/kyt/withdrawal-attempts/{externalId}/alerts
Method:GET
接口描述:
路径参数
参数名称 | 示例 | 备注 |
---|---|---|
externalId | 生成的此提款尝试的标识符 |
名称 | 类型 | 是否必须 | 默认值 | 备注 | 其他信息 |
---|---|---|---|---|---|
success | boolean | 非必须 | |||
code | integer | 非必须 | |||
msg | string | 非必须 | |||
data | object | 非必须 | |||
├─alerts | object [] | 非必须 | 包含给定传输的警报信息。如果没有生成警报,则该数组将为空 |
item 类型: object |
|
├─alertLevel | string | 非必须 | 将警报的风险定义为super_high高危、high高、medium中、low低 | ||
├─category | string | 非必须 | 警报规则正在跟踪的实体类别 | ||
├─service | string | 非必须 | 定义的服务名称 | ||
├─externalId | string | 非必须 | 警报的唯一标识 | ||
├─alertAmount | number | 非必须 | 导致触发警报的美元金额 | ||
├─exposureType | string | 非必须 | 将曝光方向定义为DIRECT或INDIRECT,注意:目前仅支持DIRECT | ||
├─categoryId | string | 非必须 | 实体类别的唯一标识符 | ||
├─strategy | object | 非必须 | 策略 | ||
├─strategy | string | 非必须 | 策略名称 | ||
├─rule | string | 非必须 | 规则名称 | ||
├─level | string | 非必须 | 预警等级 | ||
├─decisionCode | string | 非必须 | 决策树code | ||
├─decisionMarker | string | 非必须 | 决策树输出 |