Provides all the compliance details for the given screened transaction.

GET

screening

transaction

{txId}

TypeScript

const response: Promise<FireblocksResponse<ComplianceResultFullPayload>> = fireblocks.compliance.getScreeningFullDetails(complianceApiGetScreeningFullDetailsRequest);

CompletableFuture<ApiResponse<ComplianceResultFullPayload>> response = fireblocks.compliance().getScreeningFullDetails(txId);

response = fireblocks.compliance.get_screening_full_details(tx_id);

curl --request GET \
  --url https://api.fireblocks.io/v1/screening/transaction/{txId}

const options = {method: 'GET'};

fetch('https://api.fireblocks.io/v1/screening/transaction/{txId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.fireblocks.io/v1/screening/transaction/{txId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.fireblocks.io/v1/screening/transaction/{txId}"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.fireblocks.io/v1/screening/transaction/{txId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body

{
  "aml": {
    "provider": "NOTABENE",
    "payload": {},
    "timestamp": 1753459111824,
    "screeningStatus": "COMPLETED",
    "bypassReason": "UNSUPPORTED_ASSET",
    "status": "COMPLETED",
    "prevStatus": "COMPLETED",
    "prevBypassReason": "BELOW_THRESHOLD",
    "verdict": "PASS",
    "risk": "lowRisk",
    "extendedRisk": "lowRisk",
    "externalId": "aml_screening_12345",
    "customerRefId": "customer_ref_789",
    "refId": "ref_12345",
    "category": "EXCHANGE",
    "categoryId": 5,
    "destAddress": "0xA2dC2490ED1DcA2D21613508fdb0c82daEAb0715",
    "destTag": "memo_12345",
    "destRecordId": "record_001",
    "addressResolutionSignature": "0x1234567890abcdef",
    "amlResult": {
      "alerts": [
        {
          "alertLevel": "HIGH",
          "externalId": "alert_12345",
          "alertAmount": 1000.5,
          "exposureType": "DIRECT",
          "alertName": "Sanctions Match",
          "category": "SANCTIONED_ENTITY",
          "service": "CHAINALYSIS",
          "policyAction": "BLOCK",
          "categoryId": 101
        }
      ],
      "providerResponse": {},
      "matchedRule": {
        "ruleId": "rule_001",
        "ruleName": "High Risk Sanctions Check",
        "action": "ALLOW"
      },
      "matchedAlert": {
        "alertLevel": "HIGH",
        "externalId": "alert_12345",
        "alertAmount": 1000.5,
        "exposureType": "DIRECT",
        "alertName": "Sanctions Match",
        "category": "SANCTIONED_ENTITY",
        "service": "CHAINALYSIS",
        "policyAction": "BLOCK",
        "categoryId": 101
      }
    },
    "result": {
      "direction": "OUTBOUND",
      "isVerified": true,
      "action": "ACCEPT",
      "providerResponse": {},
      "matchedRule": {
        "direction": "OUTBOUND",
        "status": "COMPLETED",
        "amountUSD": 1000.5,
        "amount": 0.025,
        "asset": "BTC",
        "action": "ACCEPT"
      }
    },
    "detailsMessage": "Travel rule screening completed successfully",
    "matchedAlert": {},
    "matchedRule": {},
    "matchedPrescreeningRule": {
      "bypassReason": "MANUAL",
      "sourceType": "VAULT_ACCOUNT",
      "sourceSubType": "INTERNAL",
      "destType": "VAULT_ACCOUNT",
      "destSubType": "INTERNAL",
      "transferPeerType": "VAULT_ACCOUNT",
      "transferPeerSubType": "INTERNAL",
      "destAddress": "0xA2dC2490ED1DcA2D21613508fdb0c82daEAb0715",
      "sourceId": "0",
      "destId": "2",
      "asset": "ETH",
      "baseAsset": "ETH",
      "amount": 0.5,
      "amountUSD": 1000,
      "networkProtocol": "ETH",
      "operation": "TRANSFER",
      "action": "SCREEN"
    },
    "matchedNoTrmScreeningRule": {},
    "customerIntegrationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "customerShortName": "ACME Corp",
    "travelRuleMessageId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "providerResponse": {}
  },
  "tr": {
    "provider": "NOTABENE",
    "payload": {},
    "timestamp": 1753459111824,
    "screeningStatus": "COMPLETED",
    "bypassReason": "UNSUPPORTED_ASSET",
    "status": "COMPLETED",
    "prevStatus": "COMPLETED",
    "prevBypassReason": "BELOW_THRESHOLD",
    "verdict": "PASS",
    "risk": "lowRisk",
    "extendedRisk": "lowRisk",
    "externalId": "aml_screening_12345",
    "customerRefId": "customer_ref_789",
    "refId": "ref_12345",
    "category": "EXCHANGE",
    "categoryId": 5,
    "destAddress": "0xA2dC2490ED1DcA2D21613508fdb0c82daEAb0715",
    "destTag": "memo_12345",
    "destRecordId": "record_001",
    "addressResolutionSignature": "0x1234567890abcdef",
    "amlResult": {
      "alerts": [
        {
          "alertLevel": "HIGH",
          "externalId": "alert_12345",
          "alertAmount": 1000.5,
          "exposureType": "DIRECT",
          "alertName": "Sanctions Match",
          "category": "SANCTIONED_ENTITY",
          "service": "CHAINALYSIS",
          "policyAction": "BLOCK",
          "categoryId": 101
        }
      ],
      "providerResponse": {},
      "matchedRule": {
        "ruleId": "rule_001",
        "ruleName": "High Risk Sanctions Check",
        "action": "ALLOW"
      },
      "matchedAlert": {
        "alertLevel": "HIGH",
        "externalId": "alert_12345",
        "alertAmount": 1000.5,
        "exposureType": "DIRECT",
        "alertName": "Sanctions Match",
        "category": "SANCTIONED_ENTITY",
        "service": "CHAINALYSIS",
        "policyAction": "BLOCK",
        "categoryId": 101
      }
    },
    "result": {
      "direction": "OUTBOUND",
      "isVerified": true,
      "action": "ACCEPT",
      "providerResponse": {},
      "matchedRule": {
        "direction": "OUTBOUND",
        "status": "COMPLETED",
        "amountUSD": 1000.5,
        "amount": 0.025,
        "asset": "BTC",
        "action": "ACCEPT"
      }
    },
    "detailsMessage": "Travel rule screening completed successfully",
    "matchedAlert": {},
    "matchedRule": {},
    "matchedPrescreeningRule": {
      "bypassReason": "MANUAL",
      "sourceType": "VAULT_ACCOUNT",
      "sourceSubType": "INTERNAL",
      "destType": "VAULT_ACCOUNT",
      "destSubType": "INTERNAL",
      "transferPeerType": "VAULT_ACCOUNT",
      "transferPeerSubType": "INTERNAL",
      "destAddress": "0xA2dC2490ED1DcA2D21613508fdb0c82daEAb0715",
      "sourceId": "0",
      "destId": "2",
      "asset": "ETH",
      "baseAsset": "ETH",
      "amount": 0.5,
      "amountUSD": 1000,
      "networkProtocol": "ETH",
      "operation": "TRANSFER",
      "action": "SCREEN"
    },
    "matchedNoTrmScreeningRule": {},
    "customerIntegrationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "customerShortName": "ACME Corp",
    "travelRuleMessageId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "providerResponse": {}
  },
  "amlList": [
    {
      "provider": "NOTABENE",
      "payload": {},
      "timestamp": 1753459111824,
      "screeningStatus": "COMPLETED",
      "bypassReason": "UNSUPPORTED_ASSET",
      "status": "COMPLETED",
      "prevStatus": "COMPLETED",
      "prevBypassReason": "BELOW_THRESHOLD",
      "verdict": "PASS",
      "risk": "lowRisk",
      "extendedRisk": "lowRisk",
      "externalId": "aml_screening_12345",
      "customerRefId": "customer_ref_789",
      "refId": "ref_12345",
      "category": "EXCHANGE",
      "categoryId": 5,
      "destAddress": "0xA2dC2490ED1DcA2D21613508fdb0c82daEAb0715",
      "destTag": "memo_12345",
      "destRecordId": "record_001",
      "addressResolutionSignature": "0x1234567890abcdef",
      "amlResult": {
        "alerts": [
          {
            "alertLevel": "HIGH",
            "externalId": "alert_12345",
            "alertAmount": 1000.5,
            "exposureType": "DIRECT",
            "alertName": "Sanctions Match",
            "category": "SANCTIONED_ENTITY",
            "service": "CHAINALYSIS",
            "policyAction": "BLOCK",
            "categoryId": 101
          }
        ],
        "providerResponse": {},
        "matchedRule": {
          "ruleId": "rule_001",
          "ruleName": "High Risk Sanctions Check",
          "action": "ALLOW"
        },
        "matchedAlert": {
          "alertLevel": "HIGH",
          "externalId": "alert_12345",
          "alertAmount": 1000.5,
          "exposureType": "DIRECT",
          "alertName": "Sanctions Match",
          "category": "SANCTIONED_ENTITY",
          "service": "CHAINALYSIS",
          "policyAction": "BLOCK",
          "categoryId": 101
        }
      },
      "result": {
        "direction": "OUTBOUND",
        "isVerified": true,
        "action": "ACCEPT",
        "providerResponse": {},
        "matchedRule": {
          "direction": "OUTBOUND",
          "status": "COMPLETED",
          "amountUSD": 1000.5,
          "amount": 0.025,
          "asset": "BTC",
          "action": "ACCEPT"
        }
      },
      "detailsMessage": "Travel rule screening completed successfully",
      "matchedAlert": {},
      "matchedRule": {},
      "matchedPrescreeningRule": {
        "bypassReason": "MANUAL",
        "sourceType": "VAULT_ACCOUNT",
        "sourceSubType": "INTERNAL",
        "destType": "VAULT_ACCOUNT",
        "destSubType": "INTERNAL",
        "transferPeerType": "VAULT_ACCOUNT",
        "transferPeerSubType": "INTERNAL",
        "destAddress": "0xA2dC2490ED1DcA2D21613508fdb0c82daEAb0715",
        "sourceId": "0",
        "destId": "2",
        "asset": "ETH",
        "baseAsset": "ETH",
        "amount": 0.5,
        "amountUSD": 1000,
        "networkProtocol": "ETH",
        "operation": "TRANSFER",
        "action": "SCREEN"
      },
      "matchedNoTrmScreeningRule": {},
      "customerIntegrationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "customerShortName": "ACME Corp",
      "travelRuleMessageId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "providerResponse": {}
    }
  ],
  "status": "Completed",
  "amlRegistration": {
    "provider": "<string>",
    "success": true,
    "timestamp": 123
  },
  "trlinkRegistration": {
    "status": "COMPLETED",
    "timestamp": 1640995200000,
    "provider": "SUMSUB",
    "success": true,
    "destRecordId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "travelRuleMessageId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "customerIntegrationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "customerShortName": "ACME Corp",
    "result": {
      "providerResponse": {}
    },
    "matchedPrescreeningRule": {
      "action": "SCREEN",
      "customerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "direction": "OUTBOUND",
      "sourceType": "VAULT_ACCOUNT",
      "sourceSubType": "INTERNAL",
      "sourceAddress": "1A1zP1eP5QGefi2DMPTfTL5SLmv7DivfNa",
      "destType": "VAULT_ACCOUNT",
      "destSubType": "INTERNAL",
      "destAddress": "1A1zP1eP5QGefi2DMPTfTL5SLmv7DivfNa",
      "sourceId": "1",
      "destId": "1",
      "asset": "BTC",
      "baseAsset": "USD",
      "amount": {
        "range": {
          "min": "100",
          "max": "10000"
        },
        "currency": "USD"
      },
      "networkProtocol": "BITCOIN",
      "operation": "TRANSFER",
      "description": "Rule for high-value BTC transfers",
      "isDefault": false
    }
  },
  "trlinkDestinations": [
    {
      "provider": "SUMSUB",
      "timestamp": 1640995200000,
      "verdict": "ACCEPT",
      "destAddress": "0xA2dC2490ED1DcA2D21613508fdb0c82daEAb0715",
      "destTag": "memo_12345",
      "bypassReason": "MANUAL",
      "detailsMessage": "Screening completed successfully",
      "customerIntegrationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "customerShortName": "ACME Corp",
      "travelRuleMessageId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "result": {
        "providerResponse": {},
        "matchedRule": {
          "action": "ACCEPT",
          "customerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "direction": "OUTBOUND",
          "sourceType": "VAULT_ACCOUNT",
          "sourceSubType": "INTERNAL",
          "sourceAddress": "1A1zP1eP5QGefi2DMPTfTL5SLmv7DivfNa",
          "destType": "VAULT_ACCOUNT",
          "destSubType": "INTERNAL",
          "destAddress": "1A1zP1eP5QGefi2DMPTfTL5SLmv7DivfNa",
          "sourceId": "1",
          "destId": "1",
          "asset": "BTC",
          "baseAsset": "USD",
          "amount": {
            "range": {
              "min": "100",
              "max": "10000"
            },
            "currency": "USD"
          },
          "networkProtocol": "BITCOIN",
          "operation": "TRANSFER",
          "description": "Rule for high-value BTC transfers",
          "isDefault": false,
          "providerIdent": "sumsub",
          "trmStatus": "ACCEPTED",
          "validBefore": 1672531200000,
          "validAfter": 1640995200000
        }
      },
      "matchedPrescreeningRule": {
        "action": "SCREEN",
        "customerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "direction": "OUTBOUND",
        "sourceType": "VAULT_ACCOUNT",
        "sourceSubType": "INTERNAL",
        "sourceAddress": "1A1zP1eP5QGefi2DMPTfTL5SLmv7DivfNa",
        "destType": "VAULT_ACCOUNT",
        "destSubType": "INTERNAL",
        "destAddress": "1A1zP1eP5QGefi2DMPTfTL5SLmv7DivfNa",
        "sourceId": "1",
        "destId": "1",
        "asset": "BTC",
        "baseAsset": "USD",
        "amount": {
          "range": {
            "min": "100",
            "max": "10000"
          },
          "currency": "USD"
        },
        "networkProtocol": "BITCOIN",
        "operation": "TRANSFER",
        "description": "Rule for high-value BTC transfers",
        "isDefault": false
      },
      "matchedNoTrmScreeningRule": {
        "action": "WAIT",
        "source": "policy",
        "customerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "direction": "OUTBOUND",
        "sourceType": "VAULT_ACCOUNT",
        "sourceSubType": "INTERNAL",
        "sourceAddress": "1A1zP1eP5QGefi2DMPTfTL5SLmv7DivfNa",
        "destType": "VAULT_ACCOUNT",
        "destSubType": "INTERNAL",
        "destAddress": "1A1zP1eP5QGefi2DMPTfTL5SLmv7DivfNa",
        "sourceId": "1",
        "destId": "1",
        "asset": "BTC",
        "baseAsset": "USD",
        "amount": {
          "range": {
            "min": "100",
            "max": "10000"
          },
          "currency": "USD"
        },
        "networkProtocol": "BITCOIN",
        "operation": "TRANSFER",
        "description": "Rule for high-value BTC transfers",
        "isDefault": false,
        "validBefore": 1672531200000,
        "validAfter": 1640995200000,
        "timestamp": "2023-10-05T14:48:00.000Z",
        "reason": "Missing travel rule message"
      }
    }
  ]
}

{
  "message": "<string>",
  "code": 123
}

Path Parameters

txId

string

required

Fireblocks transaction ID of the screened transaction

Response

A compliance object

The result of the Compliance AML/Travel Rule screening.

aml

object

The result of the AML/Travel Rule screening. This unified schema contains all fields that may be returned for both AML and Travel Rule screening results. Not all fields will be present in every response - the actual fields depend on the screening type and provider.

Show child attributes

object

Show child attributes

amlList

object[]

The list of all results of the AML screening.

Show child attributes

status

enum<string>

Status of compliance result screening

Available options:

Unknown,

Stalled,

Started,

NetworkConnectionAddressResolve,

ScreeningPrepare,

AMLStarted,

AMLCompleted,

AMLFailed,

AMLInBackground,

TRPreconditionChecks,

TRStarted,

TRLinkStarted,

TRLinkDestinationStarted,

TRLinkDestinationPrescreenPolicy,

TRLinkDestinationNoTRMPolicy,

TRLinkDestinationScreen,

TRLinkDestinationPostscreenPolicy,

TRLinkDestinationCompleted,

TRLinkCompleted,

TRCompleted,

TRFailed,

Completed,

RegistrationStarted,

RegistrationWaitForFirstConfirmation,

AMLRegistrationStarted,

AMLRegistrationCompleted,

TRUpdateStarted,

TRUpdateCompleted,

UpdateCompleted,

IncomingStarted,

IncomingByorkSL,

IncomingScreeningPrepare,

IncomingWaitForFirstConfirmation,

AMLIncomingStarted,

AMLIncomingCompleted,

AMLIncomingFailed,

AMLIncomingInBackground,

TRIncomingStarted,

TRIncomingCompleted,

TRIncomingFailed,

IncomingCompleted,

AddressAmlInitiated,

AddressAmlAddressResolve,

AddressAmlPrepare,

AddressAmlProcessing,

AddressAmlSucceeded,

AddressAmlFailed,

AddressAmlCompleted

Example:

"Completed"

amlRegistration

object

The results of the AML address registration.

Show child attributes

trlinkRegistration

object

TRLink registration result containing status and metadata

Show child attributes

trlinkDestinations

object[]

The list of TRLink destination screening results.

Show child attributes

Bypass Screening PolicyTriggers a new transaction, with the API user as the initiator, bypassing the screening policy checks. This endpoint is restricted to Admin API users and is only applicable to outgoing transactions.

⌘I

TypeScript

const response: Promise<FireblocksResponse<ComplianceResultFullPayload>> = fireblocks.compliance.getScreeningFullDetails(complianceApiGetScreeningFullDetailsRequest);

CompletableFuture<ApiResponse<ComplianceResultFullPayload>> response = fireblocks.compliance().getScreeningFullDetails(txId);

response = fireblocks.compliance.get_screening_full_details(tx_id);

curl --request GET \
  --url https://api.fireblocks.io/v1/screening/transaction/{txId}

const options = {method: 'GET'};

fetch('https://api.fireblocks.io/v1/screening/transaction/{txId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.fireblocks.io/v1/screening/transaction/{txId}",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.fireblocks.io/v1/screening/transaction/{txId}"

	req, _ := http.NewRequest("GET", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://api.fireblocks.io/v1/screening/transaction/{txId}")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)

response = http.request(request)
puts response.read_body

{
  "aml": {
    "provider": "NOTABENE",
    "payload": {},
    "timestamp": 1753459111824,
    "screeningStatus": "COMPLETED",
    "bypassReason": "UNSUPPORTED_ASSET",
    "status": "COMPLETED",
    "prevStatus": "COMPLETED",
    "prevBypassReason": "BELOW_THRESHOLD",
    "verdict": "PASS",
    "risk": "lowRisk",
    "extendedRisk": "lowRisk",
    "externalId": "aml_screening_12345",
    "customerRefId": "customer_ref_789",
    "refId": "ref_12345",
    "category": "EXCHANGE",
    "categoryId": 5,
    "destAddress": "0xA2dC2490ED1DcA2D21613508fdb0c82daEAb0715",
    "destTag": "memo_12345",
    "destRecordId": "record_001",
    "addressResolutionSignature": "0x1234567890abcdef",
    "amlResult": {
      "alerts": [
        {
          "alertLevel": "HIGH",
          "externalId": "alert_12345",
          "alertAmount": 1000.5,
          "exposureType": "DIRECT",
          "alertName": "Sanctions Match",
          "category": "SANCTIONED_ENTITY",
          "service": "CHAINALYSIS",
          "policyAction": "BLOCK",
          "categoryId": 101
        }
      ],
      "providerResponse": {},
      "matchedRule": {
        "ruleId": "rule_001",
        "ruleName": "High Risk Sanctions Check",
        "action": "ALLOW"
      },
      "matchedAlert": {
        "alertLevel": "HIGH",
        "externalId": "alert_12345",
        "alertAmount": 1000.5,
        "exposureType": "DIRECT",
        "alertName": "Sanctions Match",
        "category": "SANCTIONED_ENTITY",
        "service": "CHAINALYSIS",
        "policyAction": "BLOCK",
        "categoryId": 101
      }
    },
    "result": {
      "direction": "OUTBOUND",
      "isVerified": true,
      "action": "ACCEPT",
      "providerResponse": {},
      "matchedRule": {
        "direction": "OUTBOUND",
        "status": "COMPLETED",
        "amountUSD": 1000.5,
        "amount": 0.025,
        "asset": "BTC",
        "action": "ACCEPT"
      }
    },
    "detailsMessage": "Travel rule screening completed successfully",
    "matchedAlert": {},
    "matchedRule": {},
    "matchedPrescreeningRule": {
      "bypassReason": "MANUAL",
      "sourceType": "VAULT_ACCOUNT",
      "sourceSubType": "INTERNAL",
      "destType": "VAULT_ACCOUNT",
      "destSubType": "INTERNAL",
      "transferPeerType": "VAULT_ACCOUNT",
      "transferPeerSubType": "INTERNAL",
      "destAddress": "0xA2dC2490ED1DcA2D21613508fdb0c82daEAb0715",
      "sourceId": "0",
      "destId": "2",
      "asset": "ETH",
      "baseAsset": "ETH",
      "amount": 0.5,
      "amountUSD": 1000,
      "networkProtocol": "ETH",
      "operation": "TRANSFER",
      "action": "SCREEN"
    },
    "matchedNoTrmScreeningRule": {},
    "customerIntegrationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "customerShortName": "ACME Corp",
    "travelRuleMessageId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "providerResponse": {}
  },
  "tr": {
    "provider": "NOTABENE",
    "payload": {},
    "timestamp": 1753459111824,
    "screeningStatus": "COMPLETED",
    "bypassReason": "UNSUPPORTED_ASSET",
    "status": "COMPLETED",
    "prevStatus": "COMPLETED",
    "prevBypassReason": "BELOW_THRESHOLD",
    "verdict": "PASS",
    "risk": "lowRisk",
    "extendedRisk": "lowRisk",
    "externalId": "aml_screening_12345",
    "customerRefId": "customer_ref_789",
    "refId": "ref_12345",
    "category": "EXCHANGE",
    "categoryId": 5,
    "destAddress": "0xA2dC2490ED1DcA2D21613508fdb0c82daEAb0715",
    "destTag": "memo_12345",
    "destRecordId": "record_001",
    "addressResolutionSignature": "0x1234567890abcdef",
    "amlResult": {
      "alerts": [
        {
          "alertLevel": "HIGH",
          "externalId": "alert_12345",
          "alertAmount": 1000.5,
          "exposureType": "DIRECT",
          "alertName": "Sanctions Match",
          "category": "SANCTIONED_ENTITY",
          "service": "CHAINALYSIS",
          "policyAction": "BLOCK",
          "categoryId": 101
        }
      ],
      "providerResponse": {},
      "matchedRule": {
        "ruleId": "rule_001",
        "ruleName": "High Risk Sanctions Check",
        "action": "ALLOW"
      },
      "matchedAlert": {
        "alertLevel": "HIGH",
        "externalId": "alert_12345",
        "alertAmount": 1000.5,
        "exposureType": "DIRECT",
        "alertName": "Sanctions Match",
        "category": "SANCTIONED_ENTITY",
        "service": "CHAINALYSIS",
        "policyAction": "BLOCK",
        "categoryId": 101
      }
    },
    "result": {
      "direction": "OUTBOUND",
      "isVerified": true,
      "action": "ACCEPT",
      "providerResponse": {},
      "matchedRule": {
        "direction": "OUTBOUND",
        "status": "COMPLETED",
        "amountUSD": 1000.5,
        "amount": 0.025,
        "asset": "BTC",
        "action": "ACCEPT"
      }
    },
    "detailsMessage": "Travel rule screening completed successfully",
    "matchedAlert": {},
    "matchedRule": {},
    "matchedPrescreeningRule": {
      "bypassReason": "MANUAL",
      "sourceType": "VAULT_ACCOUNT",
      "sourceSubType": "INTERNAL",
      "destType": "VAULT_ACCOUNT",
      "destSubType": "INTERNAL",
      "transferPeerType": "VAULT_ACCOUNT",
      "transferPeerSubType": "INTERNAL",
      "destAddress": "0xA2dC2490ED1DcA2D21613508fdb0c82daEAb0715",
      "sourceId": "0",
      "destId": "2",
      "asset": "ETH",
      "baseAsset": "ETH",
      "amount": 0.5,
      "amountUSD": 1000,
      "networkProtocol": "ETH",
      "operation": "TRANSFER",
      "action": "SCREEN"
    },
    "matchedNoTrmScreeningRule": {},
    "customerIntegrationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "customerShortName": "ACME Corp",
    "travelRuleMessageId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "providerResponse": {}
  },
  "amlList": [
    {
      "provider": "NOTABENE",
      "payload": {},
      "timestamp": 1753459111824,
      "screeningStatus": "COMPLETED",
      "bypassReason": "UNSUPPORTED_ASSET",
      "status": "COMPLETED",
      "prevStatus": "COMPLETED",
      "prevBypassReason": "BELOW_THRESHOLD",
      "verdict": "PASS",
      "risk": "lowRisk",
      "extendedRisk": "lowRisk",
      "externalId": "aml_screening_12345",
      "customerRefId": "customer_ref_789",
      "refId": "ref_12345",
      "category": "EXCHANGE",
      "categoryId": 5,
      "destAddress": "0xA2dC2490ED1DcA2D21613508fdb0c82daEAb0715",
      "destTag": "memo_12345",
      "destRecordId": "record_001",
      "addressResolutionSignature": "0x1234567890abcdef",
      "amlResult": {
        "alerts": [
          {
            "alertLevel": "HIGH",
            "externalId": "alert_12345",
            "alertAmount": 1000.5,
            "exposureType": "DIRECT",
            "alertName": "Sanctions Match",
            "category": "SANCTIONED_ENTITY",
            "service": "CHAINALYSIS",
            "policyAction": "BLOCK",
            "categoryId": 101
          }
        ],
        "providerResponse": {},
        "matchedRule": {
          "ruleId": "rule_001",
          "ruleName": "High Risk Sanctions Check",
          "action": "ALLOW"
        },
        "matchedAlert": {
          "alertLevel": "HIGH",
          "externalId": "alert_12345",
          "alertAmount": 1000.5,
          "exposureType": "DIRECT",
          "alertName": "Sanctions Match",
          "category": "SANCTIONED_ENTITY",
          "service": "CHAINALYSIS",
          "policyAction": "BLOCK",
          "categoryId": 101
        }
      },
      "result": {
        "direction": "OUTBOUND",
        "isVerified": true,
        "action": "ACCEPT",
        "providerResponse": {},
        "matchedRule": {
          "direction": "OUTBOUND",
          "status": "COMPLETED",
          "amountUSD": 1000.5,
          "amount": 0.025,
          "asset": "BTC",
          "action": "ACCEPT"
        }
      },
      "detailsMessage": "Travel rule screening completed successfully",
      "matchedAlert": {},
      "matchedRule": {},
      "matchedPrescreeningRule": {
        "bypassReason": "MANUAL",
        "sourceType": "VAULT_ACCOUNT",
        "sourceSubType": "INTERNAL",
        "destType": "VAULT_ACCOUNT",
        "destSubType": "INTERNAL",
        "transferPeerType": "VAULT_ACCOUNT",
        "transferPeerSubType": "INTERNAL",
        "destAddress": "0xA2dC2490ED1DcA2D21613508fdb0c82daEAb0715",
        "sourceId": "0",
        "destId": "2",
        "asset": "ETH",
        "baseAsset": "ETH",
        "amount": 0.5,
        "amountUSD": 1000,
        "networkProtocol": "ETH",
        "operation": "TRANSFER",
        "action": "SCREEN"
      },
      "matchedNoTrmScreeningRule": {},
      "customerIntegrationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "customerShortName": "ACME Corp",
      "travelRuleMessageId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "providerResponse": {}
    }
  ],
  "status": "Completed",
  "amlRegistration": {
    "provider": "<string>",
    "success": true,
    "timestamp": 123
  },
  "trlinkRegistration": {
    "status": "COMPLETED",
    "timestamp": 1640995200000,
    "provider": "SUMSUB",
    "success": true,
    "destRecordId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "travelRuleMessageId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "customerIntegrationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "customerShortName": "ACME Corp",
    "result": {
      "providerResponse": {}
    },
    "matchedPrescreeningRule": {
      "action": "SCREEN",
      "customerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "direction": "OUTBOUND",
      "sourceType": "VAULT_ACCOUNT",
      "sourceSubType": "INTERNAL",
      "sourceAddress": "1A1zP1eP5QGefi2DMPTfTL5SLmv7DivfNa",
      "destType": "VAULT_ACCOUNT",
      "destSubType": "INTERNAL",
      "destAddress": "1A1zP1eP5QGefi2DMPTfTL5SLmv7DivfNa",
      "sourceId": "1",
      "destId": "1",
      "asset": "BTC",
      "baseAsset": "USD",
      "amount": {
        "range": {
          "min": "100",
          "max": "10000"
        },
        "currency": "USD"
      },
      "networkProtocol": "BITCOIN",
      "operation": "TRANSFER",
      "description": "Rule for high-value BTC transfers",
      "isDefault": false
    }
  },
  "trlinkDestinations": [
    {
      "provider": "SUMSUB",
      "timestamp": 1640995200000,
      "verdict": "ACCEPT",
      "destAddress": "0xA2dC2490ED1DcA2D21613508fdb0c82daEAb0715",
      "destTag": "memo_12345",
      "bypassReason": "MANUAL",
      "detailsMessage": "Screening completed successfully",
      "customerIntegrationId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "customerShortName": "ACME Corp",
      "travelRuleMessageId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
      "result": {
        "providerResponse": {},
        "matchedRule": {
          "action": "ACCEPT",
          "customerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
          "direction": "OUTBOUND",
          "sourceType": "VAULT_ACCOUNT",
          "sourceSubType": "INTERNAL",
          "sourceAddress": "1A1zP1eP5QGefi2DMPTfTL5SLmv7DivfNa",
          "destType": "VAULT_ACCOUNT",
          "destSubType": "INTERNAL",
          "destAddress": "1A1zP1eP5QGefi2DMPTfTL5SLmv7DivfNa",
          "sourceId": "1",
          "destId": "1",
          "asset": "BTC",
          "baseAsset": "USD",
          "amount": {
            "range": {
              "min": "100",
              "max": "10000"
            },
            "currency": "USD"
          },
          "networkProtocol": "BITCOIN",
          "operation": "TRANSFER",
          "description": "Rule for high-value BTC transfers",
          "isDefault": false,
          "providerIdent": "sumsub",
          "trmStatus": "ACCEPTED",
          "validBefore": 1672531200000,
          "validAfter": 1640995200000
        }
      },
      "matchedPrescreeningRule": {
        "action": "SCREEN",
        "customerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "direction": "OUTBOUND",
        "sourceType": "VAULT_ACCOUNT",
        "sourceSubType": "INTERNAL",
        "sourceAddress": "1A1zP1eP5QGefi2DMPTfTL5SLmv7DivfNa",
        "destType": "VAULT_ACCOUNT",
        "destSubType": "INTERNAL",
        "destAddress": "1A1zP1eP5QGefi2DMPTfTL5SLmv7DivfNa",
        "sourceId": "1",
        "destId": "1",
        "asset": "BTC",
        "baseAsset": "USD",
        "amount": {
          "range": {
            "min": "100",
            "max": "10000"
          },
          "currency": "USD"
        },
        "networkProtocol": "BITCOIN",
        "operation": "TRANSFER",
        "description": "Rule for high-value BTC transfers",
        "isDefault": false
      },
      "matchedNoTrmScreeningRule": {
        "action": "WAIT",
        "source": "policy",
        "customerId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
        "direction": "OUTBOUND",
        "sourceType": "VAULT_ACCOUNT",
        "sourceSubType": "INTERNAL",
        "sourceAddress": "1A1zP1eP5QGefi2DMPTfTL5SLmv7DivfNa",
        "destType": "VAULT_ACCOUNT",
        "destSubType": "INTERNAL",
        "destAddress": "1A1zP1eP5QGefi2DMPTfTL5SLmv7DivfNa",
        "sourceId": "1",
        "destId": "1",
        "asset": "BTC",
        "baseAsset": "USD",
        "amount": {
          "range": {
            "min": "100",
            "max": "10000"
          },
          "currency": "USD"
        },
        "networkProtocol": "BITCOIN",
        "operation": "TRANSFER",
        "description": "Rule for high-value BTC transfers",
        "isDefault": false,
        "validBefore": 1672531200000,
        "validAfter": 1640995200000,
        "timestamp": "2023-10-05T14:48:00.000Z",
        "reason": "Missing travel rule message"
      }
    }
  ]
}

{
  "message": "<string>",
  "code": 123
}

Introduction

Errors & Statuses

Data Objects

API Endpoints

Provides all the compliance details for the given screened transaction.

Path Parameters

Response