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,
"withRiskPenetrationClue": false
}
'import requests
url = "https://api.bitrace.io/api/v1/tracker/kya/custom-risk-scores"
payload = {
"address": "<string>",
"customId": "<string>",
"withAddressRiskClue": False,
"withTxRiskClue": False,
"withRiskPenetrationClue": False
}
headers = {
"X-Access-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-Access-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
address: '<string>',
customId: '<string>',
withAddressRiskClue: false,
withTxRiskClue: false,
withRiskPenetrationClue: false
})
};
fetch('https://api.bitrace.io/api/v1/tracker/kya/custom-risk-scores', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.bitrace.io/api/v1/tracker/kya/custom-risk-scores",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'address' => '<string>',
'customId' => '<string>',
'withAddressRiskClue' => false,
'withTxRiskClue' => false,
'withRiskPenetrationClue' => false
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-Access-Key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.bitrace.io/api/v1/tracker/kya/custom-risk-scores"
payload := strings.NewReader("{\n \"address\": \"<string>\",\n \"customId\": \"<string>\",\n \"withAddressRiskClue\": false,\n \"withTxRiskClue\": false,\n \"withRiskPenetrationClue\": false\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-Access-Key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.bitrace.io/api/v1/tracker/kya/custom-risk-scores")
.header("X-Access-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"address\": \"<string>\",\n \"customId\": \"<string>\",\n \"withAddressRiskClue\": false,\n \"withTxRiskClue\": false,\n \"withRiskPenetrationClue\": false\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.bitrace.io/api/v1/tracker/kya/custom-risk-scores")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-Access-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"address\": \"<string>\",\n \"customId\": \"<string>\",\n \"withAddressRiskClue\": false,\n \"withTxRiskClue\": false,\n \"withRiskPenetrationClue\": false\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"code": 1,
"status": "SUCCESS",
"data": {
"requestId": "69417729314225615324513892905990",
"status": 1000,
"customId": "123456"
},
"msg": "SUCCESS"
}KYA API
Retrieve Custom Risk Score
getAddressCustomRiskScore - This endpoint retrieves the custom risk scores by given address.
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,
"withRiskPenetrationClue": false
}
'import requests
url = "https://api.bitrace.io/api/v1/tracker/kya/custom-risk-scores"
payload = {
"address": "<string>",
"customId": "<string>",
"withAddressRiskClue": False,
"withTxRiskClue": False,
"withRiskPenetrationClue": False
}
headers = {
"X-Access-Key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-Access-Key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
address: '<string>',
customId: '<string>',
withAddressRiskClue: false,
withTxRiskClue: false,
withRiskPenetrationClue: false
})
};
fetch('https://api.bitrace.io/api/v1/tracker/kya/custom-risk-scores', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.bitrace.io/api/v1/tracker/kya/custom-risk-scores",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'address' => '<string>',
'customId' => '<string>',
'withAddressRiskClue' => false,
'withTxRiskClue' => false,
'withRiskPenetrationClue' => false
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-Access-Key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.bitrace.io/api/v1/tracker/kya/custom-risk-scores"
payload := strings.NewReader("{\n \"address\": \"<string>\",\n \"customId\": \"<string>\",\n \"withAddressRiskClue\": false,\n \"withTxRiskClue\": false,\n \"withRiskPenetrationClue\": false\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-Access-Key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.bitrace.io/api/v1/tracker/kya/custom-risk-scores")
.header("X-Access-Key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"address\": \"<string>\",\n \"customId\": \"<string>\",\n \"withAddressRiskClue\": false,\n \"withTxRiskClue\": false,\n \"withRiskPenetrationClue\": false\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.bitrace.io/api/v1/tracker/kya/custom-risk-scores")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-Access-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"address\": \"<string>\",\n \"customId\": \"<string>\",\n \"withAddressRiskClue\": false,\n \"withTxRiskClue\": false,\n \"withRiskPenetrationClue\": false\n}"
response = http.request(request)
puts response.read_body{
"success": true,
"code": 1,
"status": "SUCCESS",
"data": {
"requestId": "69417729314225615324513892905990",
"status": 1000,
"customId": "123456"
},
"msg": "SUCCESS"
}Risk Score Async Workflow
Authorizations
API key authentication
Headers
Available options:
application/json Available options:
application/json Body
application/json
- Option 1
- Option 2
The address that you want to retrieve a entity for.
The supported chainns short name, ethereum tron btc bsc See at Supported Chains
Available options:
ethereum, eth, tron, btc, bsc The identifier by user-defined, it will be included in response if provided
Include the address risk clue in the response. Default is false.
Include the transaction risk clue in the response. Default is false.
Include the risk penetration clue in the response. Default is false.