Developer Docs

Appearance

Get risk by address​

GET
/api/v4/partner/risk/by-address/{addressEVM}

Retrieve risk status for a specific wallet address.

Authorizations​

ApiKeyAuth
Type
API Key (header: X-Api-Key)

Parameters​

Path Parameters

addressEVM*
Type
string
Required

Responses​

OK

application/json
JSON
{
"status": "ok",
"payload": {
"customerId": "customer_a1b2c3d4",
"addressEVM": "0x1111111111111111111111111111111111111111",
"registerTimestamp": 1724247261,
"riskScores": [
{
"risk": "LOW",
"reviewTimestamp": 1711097427,
"reviewType": "INITIAL",
"reviewComment": "Review comment example",
"reviewData": {
"fromAddress": "0x2222222222222222222222222222222222222222",
"amount": "10000",
"totalAmount": "99999"
}
}
]
}
}

Playground​

Authorization
Variables
Key
Value

Samples​

Powered by VitePress OpenAPI

The payload.riskScores array is ordered from newest to oldest. Read riskScores[0] to get the latest completed review for the address.

Code examples ​

bash
curl -X GET "https://api.brrr.network/api/v4/partner/risk/by-address/0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045" \
  -H "X-Api-Key: YOUR_API_KEY"
javascript
const address = '0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045';

const response = await fetch(
  `https://api.brrr.network/api/v4/partner/risk/by-address/${address}`,
  {
    headers: {
      'X-Api-Key': process.env.BRRR_API_KEY,
    },
  }
);

if (!response.ok) {
  const error = await response.json();
  throw new Error(`Risk check failed: ${error.errorCode}`);
}

const data = await response.json();
const latestRisk = data.payload?.riskScores?.[0]?.risk; // 'LOW' | 'MEDIUM' | 'HIGH' | 'VERY HIGH'
const reviewType = data.payload?.riskScores?.[0]?.reviewType;
console.log('Risk level:', latestRisk, 'review type:', reviewType);

if (latestRisk === 'HIGH' || latestRisk === 'VERY HIGH') {
  console.warn('Address is blocked from settlement. Do not proceed.');
}
python
import os
import httpx

address = '0xd8dA6BF26964aF9D7eEd9e03E53415D37aA96045'

response = httpx.get(
    f'https://api.brrr.network/api/v4/partner/risk/by-address/{address}',
    headers={'X-Api-Key': os.environ['BRRR_API_KEY']},
)
response.raise_for_status()
data = response.json()

latest_risk = data['payload']['riskScores'][0]['risk']  # 'LOW' | 'MEDIUM' | 'HIGH' | 'VERY HIGH'
review_type = data['payload']['riskScores'][0]['reviewType']
print(f'Risk level: {latest_risk} ({review_type})')

if latest_risk in ('HIGH', 'VERY HIGH'):
    print('Address is blocked from settlement. Do not proceed.')