Skip to main content

Transaction 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 transaction screening, make an HTTP POST request to:

/api/v3/crypto/transactions

Example request
curl -X 'POST' 'https://screenings-api-test.globalpass.ch/api/v3/crypto/transactions' -H 'accept: text/plain' -H 'Authorization: Bearer {your_access_token}' -H 'Content-Type: application/json' -d '{"hash": "string","direction": "string","outputAddress": "string","externalId": "string"}

Where:

PropertyDescription
hashTransaction hash. Required value.
directionSpecification whether you will be running a source or destination of funds analysis. Required value.
outputAddressAddress of the wallet where the funds were sent to in the analyzed transaction. Required value.
externalIdYour custom unique identifier of the screened customer, or any other external identifier. Required value.

Possible direction values:

  • source_of_funds – gets details of the entities that have contributed funds to the transaction's source address and calculates a risk score based on this exposure
  • destination_of_funds – gets details of the entities that funds have gone to from this transaction's destination address and calculate a risk score based on this exposure
Example Destination of Funds request
{
    "hash": "166e2010fd6141b65ac6659ed93b832787ae6241a4998dd0db61189869d1f32e",
    "direction": "destination_of_funds",
    "outputAddress": "3FjSB2Db9KiJi1KLRwvctwZ23an2yV8vwF",
    "externalId": "User123"
}
Example Source of Funds request
{
    "hash": "166e2010fd6141b65ac6659ed93b832787ae6241a4998dd0db61189869d1f32e",
    "direction": "source_of_funds",
    "outputAddress": "3FjSB2Db9KiJi1KLRwvctwZ23an2yV8vwF",
    "externalId": "User123"
}
Example response
{
    "id": "84a077e384697a97d69edd9i",
    "screeningToken": "b101d8d6-de0f-45e9-9509-0d43258a416f",
    "created": "2022-12-19T11:55:14.0377769+00:00",
    "riskScore": 10
}

Where:

PropertyDescription
idUnique identifier of the specific screening of the transaction. If rescreening of the same transaction will be performed, the ID value will refer to the exact screening of the same transaction.
screeningTokenUnique identifier of the screened transaction in the GlobalPass system.
createdTimestamp of when the specific screening of the transaction was performed.
riskScoreTransaction's risk value based on exposure in the screened direction, between 0 (no risk rules triggered) and 10 (highest possible risk level).

To get status of any given transaction screening, make an HTTP GET request to

/api/v3/crypto/transactions/{screeningToken}

Example request
curl -X 'GET' \'https://screenings-api-test.globalpass.ch/api/v3/crypto/transactions/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": 10
}

To access any given latest transaction screening report, you can navigate to:

To access a specific historical transaction screening report, you can navigate to:

Last updated on