Wallet Screening
IMPORTANT
This section explains integration for Multi-Asset Crypto Screening, launched in July 2024. If you are currently using our older Single-Asset crypto screening version, please read this article for update instructions.
IMPORTANT
Please note that Crypto Screenings use the Screening API V3 instead of V2.
To initiate a crypto wallet screening, make an HTTP POST request to
/api/v3/crypto/wallets
Example request
curl -X 'POST' 'https://screenings-api-test.globalpass.ch/api/v3/crypto/wallets' -H 'accept: text/plain' -H 'Authorization: Bearer {your_access_token}' -H 'Content-Type: application/json' -d '{"address": "1LoP929sXe5cGEuLw1tKRwDvSFVRJkqDW7","externalId": "User029"}
Where:
Property | Description |
---|---|
address | Address of the screened wallet. Required value. |
externalId | Your custom unique identifier of the screened customer, or any other external identifier. Required value. |
Example response:
Example response
{
"id": "84a077e384697a97d69edd9i",
"screeningToken": "b101d8d6-de0f-45e9-9509-0d43258a416f",
"created": "2022-12-19T11:55:14.0377769+00:00",
"riskScore": 2.9223575587389448
}
Where:
Property | Description |
---|---|
id | Unique identifier of the specific screening of the wallet. If rescreening of the same wallet will be performed, the ID value will refer to the exact screening of the same wallet. |
screeningToken | Unique identifier of the screened wallet in the GlobalPass system. |
created | Timestamp of when the specific screening of the wallet was performed. |
riskScore | Wallet's risk value based on its exposure, between 0 (no risk rules triggered) and 10 (highest possible risk level). |
To get status of any given wallet screening, make an HTTP GET request to
/api/v3/crypto/wallets/{screeningToken}
Example request
curl -X 'GET' 'https://screenings-api-test.globalpass.ch/api/v3/crypto/wallets/b101d8d6-de0f-45e9-9509-0d43258a416f' -H 'accept: text/plain' \-H 'Authorization: Bearer {your_access_token}'
Example response
{
"id": "84a077e384697a97d69edd9i",
"screeningToken": "b101d8d6-de0f-45e9-9509-0d43258a416f",
"created": "2022-12-19T11:55:14.0377769+00:00",
"riskScore": 2.9223575587389448
}
To access any given latest wallet screening report, you can navigate to:
- https://portal-test.globalpass.ch/crypto-screenings/wallet/{screeningToken} (sandbox)
- https://portal.globalpass.ch/crypto-screenings/wallet/{screeningToken} (production)
To access a specific historical wallet screening report, you can navigate to: