Skip to main content

Transaction Screening

To initiate a crypto transaction screening, make an HTTP POST request to:

/api/v2/crypto/transactions

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

Note that crypto transaction request parameters depend on the asset of the screened transaction, which is explained below.

PropertyDescription
blockchainFull name of the blockchain of the screened transaction. Required value.
tickerTicker of the asset of the screened transaction. Required value.
hashTransaction hash. Required value.
directionSpecification whether you will be running a source or destination of funds analysis. 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

Additional properties may be required in some cases:

PropertyDescription
outputAddressAddress of the output wallet of the transaction. Required value only for Bitcoin and Tron blockchain transactions, as these assets can have multiple outputs. For example, if you are analyzing a deposit into your service then you might want to specify the output address that belongs to your service. Or for a withdrawal, it might be the output address that your customer wants to send funds to.
outputIndicesZero-indexed output indices, an alternative method of specifying the relevant output of the transaction if output address is unknown. When specifying the output(s) by indices, if the provided indices reference multiple distinct addresses, the API will respond with an error.
logIndexlog_index is a necessary parameter for Ethereum blockchain transactions (except from Ether) that contain multiple ERC20 token transfers. If a screened transaction contains transfers of than more than one token, the API will respond with an error requesting to specify the logindex value. _Optional value for all Ethereum blockchain assets except from Ether.
externalIdUnique identifier of the user in your system. Required value.
Example Bitcoin Destination of Funds request body
{
    "blockchain": "bitcoin",
    "ticker": "BTC",
    "hash": "166e2010fd6141b65ac6659ed93b832787ae6241a4998dd0db61189869d1f32e",
    "direction": "destination_of_funds",
    "outputAddress": "3FjSB2Db9KiJi1KLRwvctwZ23an2yV8vwF",
    "externalId": "User123"
}
Example Ether Destination of Funds request body
{
    "blockchain": "ethereum",
    "ticker": "ETH",
    "hash": "0x8f421010cb339e407a431712bb6f75921e80abc78a2f53e34dc51479ba87bb4d",
    "direction": "destination_of_funds",
    "externalId": "ABC001"}
Example USDT (Ethereum) Source of Funds request body
{
    "blockchain": "ethereum",
    "ticker": "USDT",
    "hash": "0x8f421010cb339e407a431712bb6f75921e80abc78a2f53e34dc51479ba87bb4d",
    "direction": "source_of_funds",
    "logIndex": "125",
    "externalId": "A0001"
}
Example USDT (Tron) Source of Funds request body
{
    "blockchain": "tron",
    "ticker": "USDT",
    "hash": "53a5ff1fc8c656deb96e51fe13efecb0770fe0ca0e911a25e75711a466079e6f",
    "direction": "source_of_funds",
    "outputAddress": "TVj43VT4UXej73FEcrPCs2Tcm6bcZfH92Q",
    "externalId": "DEF501"
}

Responses will be unified in all request types.

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/v2/crypto/transactions/{screeningToken}

Example request
curl -X 'GET' \'https://screenings-api-test.globalpass.ch/api/v2/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