Get an Address' Risk Assessment

GET an address' risk assessment

get

This method returns the risk assessment for an address. Please note that an Admin needs to register your compliance provider API key in the Settings section. With no or invalid credentials, this method will return a 400 error.

Authorizations

Ledger_API_Key & Ledger_API_UserLedger_API_Key & Ledger_API_User & Ledger_Store_Auth_TokenLedger_API_UserLedger_API_User & Ledger_Store_Auth_Token

X-Ledger-API-KeystringRequired

If you've set up your API Key when initializing your LAM, you'll need to include it as a header along with the api user header. For more details, see step 5 of the get started documentation.

X-Ledger-API-UserstringRequired

(required) Username of a registered API User

Path parameters

addressstringRequired

The address

Responses

200

AddressRisk object

application/json

addressstringRequired

The address that was checked

Example: 0x71C7656EC7ab88b098defB751B7401B5f6d8976F

riskundefined · enumRequired

Address risk as defined by Ledger

Example: HIGHPossible values:

400

Invalid secret

application/json

get

/compliance/address-risk/{address}

HTTPcURLJavaScriptPython

GET /compliance/address-risk/{address} HTTP/1.1
X-Ledger-API-Key: YOUR_API_KEY
X-Ledger-API-User: YOUR_API_KEY
Accept: */*

{
  "address": "0x71C7656EC7ab88b098defB751B7401B5f6d8976F",
  "provider_details": {
    "exposures": [
      {
        "category": "exchange",
        "value": 424895.68594
      }
    ],
    "reason": "> 49% Exposure To High Risk Jurisdiction",
    "risk": "Severe"
  },
  "risk": "HIGH"
}