Skip to main content
POST
/
api
/
v1
/
tracker
/
kya
/
custom-risk-scores
Retrieve Custom Risk Score
curl --request POST \
  --url https://api.bitrace.io/api/v1/tracker/kya/custom-risk-scores \
  --header 'Content-Type: application/json' \
  --header 'X-Access-Key: <api-key>' \
  --data '
{
  "address": "<string>",
  "customId": "<string>",
  "withAddressRiskClue": false,
  "withTxRiskClue": false
}
'
{
  "success": true,
  "code": 1,
  "status": "SUCCESS",
  "data": {
    "requestId": "69417729314225615324513892905990",
    "status": 1000,
    "customId": "123456"
  },
  "msg": "SUCCESS"
}

Documentation Index

Fetch the complete documentation index at: https://docs.bitrace.io/llms.txt

Use this file to discover all available pages before exploring further.

​
Risk Score Async Workflow

Authorizations

​
X-Access-Key
string
header
required

API key authentication

Headers

​
Content-Type
enum<string>
default:application/json
Available options:
application/json
​
Accept
enum<string>
default:application/json
Available options:
application/json

Body

application/json
​
address
string
required

The address that you want to retrieve a entity for.

​
network
enum<string>
required

The supported chainns short name, ethereum tron btc bsc See at Supported Chains

Available options:
ethereum,
eth,
tron,
btc,
bsc
​
customId
string

The identifier by user-defined, it will be included in response if provided

​
withAddressRiskClue
boolean
default:false

Include the address risk clue in the response. Default is false.

​
withTxRiskClue
boolean
default:false

Include the transaction risk clue in the response. Default is false.

Response

Successful response

The success response from create a task to get risk score by given address.

​
success
boolean

Request success or not

​
code
integer

Response code (1 for success, other numbers for errors)

​
msg
string

SUCCESS or error message

​
data
object