API Get On-Chain AML Score

Fetch On-Chain AML Score For Wallet

GET /v1/wallets/${walletAddress}/screening

This is a server-only API route that requires a signed request signature.

See How to sign APIfor information on how to create a request signature.

Companies must have this feature enabled to take advantage of this API. To request this feature, please contact [e-mail].

Path Parameters

Name	Type	Description
walletAddress*	String	Wallet address to look up

Headers

Name	Type	Description
Authorization*		Basic ${base64(apiKey)}
Date*	String	Date and time of current request Wed, 04 Oct 2023 02:39:37 GMT
Signature*	String	API Signed Request Signature

Response

200

{
    "data": {
        "address": "0x7C5F316eD90232fCfcF68758373e45Ea9A61b800",
        "score": 1,
        "verifiedAt": 1717012571
    },
    "type": "wallet.screening"
}

400

{
    "detail": "Invalid wallet address",
    "error": "Invalid wallet address",
    "error_code": 4000
}

401

{
    "detail": "Invalid Request Signature",
    "error": "Invalid Request Signature",
    "error_code": 4012
}

403

{
    "detail": "Company is not authorized to access this endpoint",
    "error": "Company is not authorized to access this endpoint",
    "error_code": 4030
}