--- title: "Provides all the compliance details for the given screened transaction." method: GET path: "/screening/transaction/{txId}" tags: ["Compliance"] --- # Provides all the compliance details for the given screened transaction. `GET /screening/transaction/{txId}` ## Request - Base URL: `https://api.fireblocks.io/v1` - URL: `https://api.fireblocks.io/v1/screening/transaction/{txId}` - Auth: none declared - TypeScript: (a function with typed inputs; its response is checked against the schema) Provides all the compliance details for the given screened transaction. ## Path parameters - `txId` string, required ## Response `200` A compliance object - ComplianceResultFullPayload: The result of the Compliance AML/Travel Rule screening. - `aml` ComplianceScreeningResultFullPayload: 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. - `provider` string: The AML/Travel Rule provider name. For AML: ELLIPTIC, CHAINALYSIS, etc. For Travel Rule: NOTABENE, SUMSUB, GTR, or any TRLink provider name - `payload` object: The raw payload of the screening result from the provider. The payload is a JSON object that contains the screening result. The payload structure is different for each screening provider. This field contains the complete, unmodified response from the screening service. - `timestamp` number: Unix timestamp in milliseconds when the screening result was generated - `screeningStatus` 'COMPLETED' | 'PENDING' | 'BYPASSED' | 'FAILED' | 'FROZEN': Current status of the screening process - `bypassReason` string: Reason for bypassing the screening, if applicable. For AML: UNSUPPORTED_ASSET, PASSED_BY_POLICY. For Travel Rule: UNSUPPORTED_ASSET, NO_TRAVEL_RULE_MESSAGE, TRANSACTION_ZERO_AMOUNT. - `status` 'COMPLETED' | 'PENDING' | 'BYPASSED' | 'FAILED' | 'FROZEN': Deprecated: Use screeningStatus instead. AML screening status. - `prevStatus` 'COMPLETED' | 'PENDING' | 'BYPASSED' | 'FAILED' | 'FROZEN': Deprecated: Use screeningStatus instead. AML screening status. - `prevBypassReason` string: Deprecated: This field is not currently returned in the API response. Previous bypass reason before the current bypass reason change. - `verdict` 'PASS' | 'FAIL' | 'ALERT' | 'REJECT' | 'WARN' | 'TRAVEL_RULE_REQUIRED' | 'ACCEPT' | 'REVIEW' | 'WAIT': The final verdict of the screening (unified for AML, Travel Rule, and TRLink). Different providers may return different verdict values: - AML: ACCEPT, REJECT, ALERT - Travel Rule: PASS, FAIL, TRAVEL_RULE_REQUIRED - TRLink: PASS, REJECT, WARN - `risk` string: Risk level assessment for screening results. Values vary by provider and are not managed by this service. Known values by provider: - Chainalysis: severeRisk, highRisk, mediumRisk, lowRisk, noRiskInfo - Elliptic: noRiskDetected Legacy values (SCREAMING_SNAKE_CASE, may appear in old transactions): VERY_HIGH, SEVERE, HIGH, MEDIUM, LOW, NO_RISK_INFO, UNKNOWN - `extendedRisk` string: Deprecated: This field is not currently returned in the API response. Use risk instead. - `externalId` string: External identifier for the screening (provider-specific) - `customerRefId` string: Customer-provided reference identifier for tracking - `refId` string: Deprecated: This field is not currently returned in the API response. Internal reference identifier. - `category` string: Risk category classification. Examples: EXCHANGE, GAMBLING, MIXER, DARKNET_SERVICE, SANCTIONED_ENTITY - `categoryId` number: Numeric identifier for the risk category - `destAddress` string: The destination blockchain address associated with the screening - `destTag` string: Destination tag or memo (for chains that support it like XRP, XLM) - `destRecordId` string: Deprecated: This field is not currently returned in the API response. The destination record identifier used by the screening provider. - `addressResolutionSignature` string: Deprecated: This field is not currently returned in the API response. Cryptographic signature for address resolution verification. - `amlResult` ScreeningAmlResult: Deprecated: This field is not currently returned in the API response. Detailed AML screening result information. Contains alerts, risk scores, and other AML-specific data from provider-specific responses. - `alerts` ScreeningAmlAlert[]: List of AML alerts triggered during screening - `alertLevel` 'SEVERE' | 'HIGH' | 'MEDIUM' | 'LOW', required: Alert level severity - `alertName` string: Name or type of the alert - `category` string: Alert category - `service` string: Service that generated the alert - `externalId` string, required: External identifier for the alert - `alertAmount` number, required: Amount associated with the alert - `exposureType` 'DIRECT' | 'INDIRECT', required: Alert exposure type - `policyAction` string: Recommended action based on policy - `categoryId` number: Category identifier - `providerResponse` object: Complete response from the AML provider. This is a dynamic object that varies significantly between different AML providers (Chainalysis, Elliptic, etc.). Each provider has their own proprietary response format and schema. Examples of provider-specific structures: - Chainalysis: Contains cluster info, risk scores, sanctions data - Elliptic: Includes risk assessment, entity types, compliance flags The structure is provider-dependent and cannot be standardized as each vendor implements their own proprietary data models and response formats. - `matchedRule` ScreeningAmlMatchedRule: AML matched rule information - `ruleId` string: Identifier of the matched rule - `ruleName` string: Name of the matched rule - `action` 'ALLOW' | 'BLOCK' | 'SCREEN' | 'ACCEPT' | 'REJECT' | 'ALERT' | 'WAIT' | 'FREEZE' | 'CANCEL': Policy verdict action - `matchedAlert` ScreeningAmlAlert: AML alert information - `alertLevel` 'SEVERE' | 'HIGH' | 'MEDIUM' | 'LOW', required: Alert level severity - `alertName` string: Name or type of the alert - `category` string: Alert category - `service` string: Service that generated the alert - `externalId` string, required: External identifier for the alert - `alertAmount` number, required: Amount associated with the alert - `exposureType` 'DIRECT' | 'INDIRECT', required: Alert exposure type - `policyAction` string: Recommended action based on policy - `categoryId` number: Category identifier - `result` ScreeningTravelRuleResult: Deprecated: This field is not currently returned in the API response. Detailed Travel Rule screening result containing provider-specific data. Contains Travel Rule specific information like verified status, rule type, and actions. - `direction` 'INBOUND' | 'OUTBOUND': Travel rule direction - `isVerified` boolean: Whether the travel rule information was verified - `action` 'ACCEPT' | 'REJECT' | 'ALERT' | 'REVIEW' | 'WAIT' | 'FREEZE' | 'CANCEL': The final verdict of the travel rule screening - `providerResponse` object: Complete response from the travel rule provider. This is a dynamic object that varies significantly between different travel rule providers (NOTABENE etc.). Each provider has their own proprietary response format and schema. Examples of provider-specific structures: - NOTABENE: Contains VASP information, PII data, protocol-specific fields The structure is provider-dependent and cannot be standardized as each vendor implements their own proprietary data models and response formats. - `matchedRule` ScreeningTravelRuleMatchedRule: The travel rule configuration that was matched - `direction` 'INBOUND' | 'OUTBOUND': Travel rule direction - `status` 'COMPLETED' | 'PENDING' | 'BYPASSED' | 'FAILED' | 'FROZEN' | 'REJECTED' | 'CANCELED' | 'BLOCKING_TIME_EXPIRED': Travel rule status - `amountUSD` number: Amount in USD - `amount` number: Amount in base currency - `asset` string: Asset identifier - `action` 'ACCEPT' | 'REJECT' | 'ALERT' | 'REVIEW' | 'WAIT' | 'FREEZE' | 'CANCEL': The final verdict of the travel rule screening - `detailsMessage` string: Additional human-readable details or message about the screening result - `matchedAlert` object: Information about the AML alert that was matched, if any. Contains details about the specific alert that triggered during screening. - `matchedRule` object: The matched rule information for this screening result. Contains details about which screening rule was applied and matched. - `matchedPrescreeningRule` ScreeningTravelRulePrescreeningRule: Matched prescreening rule details. Prescreening rules are evaluated before the main screening to determine if screening is necessary or should be bypassed. - `bypassReason` string: Reason for bypass if prescreening rule triggered a bypass - `sourceType` 'VAULT_ACCOUNT' | 'EXCHANGE_ACCOUNT' | 'INTERNAL_WALLET' | 'EXTERNAL_WALLET' | 'CONTRACT' | 'NETWORK_CONNECTION' | 'FIAT_ACCOUNT' | 'COMPOUND' | 'GAS_STATION' | 'ONE_TIME_ADDRESS' | 'UNKNOWN' | 'END_USER_WALLET' | 'PROGRAM_CALL' | 'MULTI_DESTINATION': Transfer peer type (source or destination) - `sourceSubType` 'EXTERNAL' | 'INTERNAL' | 'CONTRACT' | 'EXCHANGETEST': Transfer peer sub-type for prescreening rules - `destType` 'VAULT_ACCOUNT' | 'EXCHANGE_ACCOUNT' | 'INTERNAL_WALLET' | 'EXTERNAL_WALLET' | 'CONTRACT' | 'NETWORK_CONNECTION' | 'FIAT_ACCOUNT' | 'COMPOUND' | 'GAS_STATION' | 'ONE_TIME_ADDRESS' | 'UNKNOWN' | 'END_USER_WALLET' | 'PROGRAM_CALL' | 'MULTI_DESTINATION': Transfer peer type (source or destination) - `destSubType` 'EXTERNAL' | 'INTERNAL' | 'CONTRACT' | 'EXCHANGETEST': Transfer peer sub-type for prescreening rules - `transferPeerType` 'VAULT_ACCOUNT' | 'EXCHANGE_ACCOUNT' | 'INTERNAL_WALLET' | 'EXTERNAL_WALLET' | 'CONTRACT' | 'NETWORK_CONNECTION' | 'FIAT_ACCOUNT' | 'COMPOUND' | 'GAS_STATION' | 'ONE_TIME_ADDRESS' | 'UNKNOWN' | 'END_USER_WALLET' | 'PROGRAM_CALL' | 'MULTI_DESTINATION': Transfer peer type (source or destination) - `transferPeerSubType` 'EXTERNAL' | 'INTERNAL' | 'CONTRACT' | 'EXCHANGETEST': Transfer peer sub-type for prescreening rules - `destAddress` string: Destination address - `sourceId` string: Source ID - `destId` string: Destination ID - `asset` string: Asset identifier - `baseAsset` string: Base asset - `amount` number: Amount - `amountUSD` number: Amount in USD - `networkProtocol` string: Network protocol - `operation` 'TRANSFER' | 'BURN' | 'CONTRACT_CALL' | 'MINT' | 'RAW' | 'TYPED_MESSAGE' | 'ENABLE_ASSET' | 'STAKE' | 'UNSTAKE' | 'WITHDRAW' | 'REDEEM_FROM_COMPOUND' | 'SUPPLY_TO_COMPOUND' | 'PROGRAM_CALL' | 'APPROVE': Transaction operation type - `action` 'SCREEN' | 'BYPASS' | 'BLOCK' | 'PASS' | 'FREEZE': Travel rule action - `matchedNoTrmScreeningRule` object: Matched no-TRM (Travel Rule Message) screening rule details. Used when TRLink screening detects a missing TRM scenario. - `customerIntegrationId` string: Customer integration identifier used by Travel Rule providers - `customerShortName` string: Customer short name registered with Travel Rule providers - `travelRuleMessageId` string: Travel rule message identifier for linking and tracking across providers - `providerResponse` ScreeningProviderResponse: Complete response from the screening provider. This is a dynamic object that varies significantly between different providers (Chainalysis, Elliptic, NOTABENE, etc.). Each provider has their own proprietary response format and schema. For AML providers: Contains risk scores, alerts, entity information For Travel Rule providers: Contains VASP information, PII data, protocol-specific fields The structure is provider-dependent and cannot be standardized as each vendor implements their own proprietary data models and response formats. - `tr` ComplianceScreeningResultFullPayload: 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. - `provider` string: The AML/Travel Rule provider name. For AML: ELLIPTIC, CHAINALYSIS, etc. For Travel Rule: NOTABENE, SUMSUB, GTR, or any TRLink provider name - `payload` object: The raw payload of the screening result from the provider. The payload is a JSON object that contains the screening result. The payload structure is different for each screening provider. This field contains the complete, unmodified response from the screening service. - `timestamp` number: Unix timestamp in milliseconds when the screening result was generated - `screeningStatus` 'COMPLETED' | 'PENDING' | 'BYPASSED' | 'FAILED' | 'FROZEN': Current status of the screening process - `bypassReason` string: Reason for bypassing the screening, if applicable. For AML: UNSUPPORTED_ASSET, PASSED_BY_POLICY. For Travel Rule: UNSUPPORTED_ASSET, NO_TRAVEL_RULE_MESSAGE, TRANSACTION_ZERO_AMOUNT. - `status` 'COMPLETED' | 'PENDING' | 'BYPASSED' | 'FAILED' | 'FROZEN': Deprecated: Use screeningStatus instead. AML screening status. - `prevStatus` 'COMPLETED' | 'PENDING' | 'BYPASSED' | 'FAILED' | 'FROZEN': Deprecated: Use screeningStatus instead. AML screening status. - `prevBypassReason` string: Deprecated: This field is not currently returned in the API response. Previous bypass reason before the current bypass reason change. - `verdict` 'PASS' | 'FAIL' | 'ALERT' | 'REJECT' | 'WARN' | 'TRAVEL_RULE_REQUIRED' | 'ACCEPT' | 'REVIEW' | 'WAIT': The final verdict of the screening (unified for AML, Travel Rule, and TRLink). Different providers may return different verdict values: - AML: ACCEPT, REJECT, ALERT - Travel Rule: PASS, FAIL, TRAVEL_RULE_REQUIRED - TRLink: PASS, REJECT, WARN - `risk` string: Risk level assessment for screening results. Values vary by provider and are not managed by this service. Known values by provider: - Chainalysis: severeRisk, highRisk, mediumRisk, lowRisk, noRiskInfo - Elliptic: noRiskDetected Legacy values (SCREAMING_SNAKE_CASE, may appear in old transactions): VERY_HIGH, SEVERE, HIGH, MEDIUM, LOW, NO_RISK_INFO, UNKNOWN - `extendedRisk` string: Deprecated: This field is not currently returned in the API response. Use risk instead. - `externalId` string: External identifier for the screening (provider-specific) - `customerRefId` string: Customer-provided reference identifier for tracking - `refId` string: Deprecated: This field is not currently returned in the API response. Internal reference identifier. - `category` string: Risk category classification. Examples: EXCHANGE, GAMBLING, MIXER, DARKNET_SERVICE, SANCTIONED_ENTITY - `categoryId` number: Numeric identifier for the risk category - `destAddress` string: The destination blockchain address associated with the screening - `destTag` string: Destination tag or memo (for chains that support it like XRP, XLM) - `destRecordId` string: Deprecated: This field is not currently returned in the API response. The destination record identifier used by the screening provider. - `addressResolutionSignature` string: Deprecated: This field is not currently returned in the API response. Cryptographic signature for address resolution verification. - `amlResult` ScreeningAmlResult: Deprecated: This field is not currently returned in the API response. Detailed AML screening result information. Contains alerts, risk scores, and other AML-specific data from provider-specific responses. - `alerts` ScreeningAmlAlert[]: List of AML alerts triggered during screening - `alertLevel` 'SEVERE' | 'HIGH' | 'MEDIUM' | 'LOW', required: Alert level severity - `alertName` string: Name or type of the alert - `category` string: Alert category - `service` string: Service that generated the alert - `externalId` string, required: External identifier for the alert - `alertAmount` number, required: Amount associated with the alert - `exposureType` 'DIRECT' | 'INDIRECT', required: Alert exposure type - `policyAction` string: Recommended action based on policy - `categoryId` number: Category identifier - `providerResponse` object: Complete response from the AML provider. This is a dynamic object that varies significantly between different AML providers (Chainalysis, Elliptic, etc.). Each provider has their own proprietary response format and schema. Examples of provider-specific structures: - Chainalysis: Contains cluster info, risk scores, sanctions data - Elliptic: Includes risk assessment, entity types, compliance flags The structure is provider-dependent and cannot be standardized as each vendor implements their own proprietary data models and response formats. - `matchedRule` ScreeningAmlMatchedRule: AML matched rule information - `ruleId` string: Identifier of the matched rule - `ruleName` string: Name of the matched rule - `action` 'ALLOW' | 'BLOCK' | 'SCREEN' | 'ACCEPT' | 'REJECT' | 'ALERT' | 'WAIT' | 'FREEZE' | 'CANCEL': Policy verdict action - `matchedAlert` ScreeningAmlAlert: AML alert information - `alertLevel` 'SEVERE' | 'HIGH' | 'MEDIUM' | 'LOW', required: Alert level severity - `alertName` string: Name or type of the alert - `category` string: Alert category - `service` string: Service that generated the alert - `externalId` string, required: External identifier for the alert - `alertAmount` number, required: Amount associated with the alert - `exposureType` 'DIRECT' | 'INDIRECT', required: Alert exposure type - `policyAction` string: Recommended action based on policy - `categoryId` number: Category identifier - `result` ScreeningTravelRuleResult: Deprecated: This field is not currently returned in the API response. Detailed Travel Rule screening result containing provider-specific data. Contains Travel Rule specific information like verified status, rule type, and actions. - `direction` 'INBOUND' | 'OUTBOUND': Travel rule direction - `isVerified` boolean: Whether the travel rule information was verified - `action` 'ACCEPT' | 'REJECT' | 'ALERT' | 'REVIEW' | 'WAIT' | 'FREEZE' | 'CANCEL': The final verdict of the travel rule screening - `providerResponse` object: Complete response from the travel rule provider. This is a dynamic object that varies significantly between different travel rule providers (NOTABENE etc.). Each provider has their own proprietary response format and schema. Examples of provider-specific structures: - NOTABENE: Contains VASP information, PII data, protocol-specific fields The structure is provider-dependent and cannot be standardized as each vendor implements their own proprietary data models and response formats. - `matchedRule` ScreeningTravelRuleMatchedRule: The travel rule configuration that was matched - `direction` 'INBOUND' | 'OUTBOUND': Travel rule direction - `status` 'COMPLETED' | 'PENDING' | 'BYPASSED' | 'FAILED' | 'FROZEN' | 'REJECTED' | 'CANCELED' | 'BLOCKING_TIME_EXPIRED': Travel rule status - `amountUSD` number: Amount in USD - `amount` number: Amount in base currency - `asset` string: Asset identifier - `action` 'ACCEPT' | 'REJECT' | 'ALERT' | 'REVIEW' | 'WAIT' | 'FREEZE' | 'CANCEL': The final verdict of the travel rule screening - `detailsMessage` string: Additional human-readable details or message about the screening result - `matchedAlert` object: Information about the AML alert that was matched, if any. Contains details about the specific alert that triggered during screening. - `matchedRule` object: The matched rule information for this screening result. Contains details about which screening rule was applied and matched. - `matchedPrescreeningRule` ScreeningTravelRulePrescreeningRule: Matched prescreening rule details. Prescreening rules are evaluated before the main screening to determine if screening is necessary or should be bypassed. - `bypassReason` string: Reason for bypass if prescreening rule triggered a bypass - `sourceType` 'VAULT_ACCOUNT' | 'EXCHANGE_ACCOUNT' | 'INTERNAL_WALLET' | 'EXTERNAL_WALLET' | 'CONTRACT' | 'NETWORK_CONNECTION' | 'FIAT_ACCOUNT' | 'COMPOUND' | 'GAS_STATION' | 'ONE_TIME_ADDRESS' | 'UNKNOWN' | 'END_USER_WALLET' | 'PROGRAM_CALL' | 'MULTI_DESTINATION': Transfer peer type (source or destination) - `sourceSubType` 'EXTERNAL' | 'INTERNAL' | 'CONTRACT' | 'EXCHANGETEST': Transfer peer sub-type for prescreening rules - `destType` 'VAULT_ACCOUNT' | 'EXCHANGE_ACCOUNT' | 'INTERNAL_WALLET' | 'EXTERNAL_WALLET' | 'CONTRACT' | 'NETWORK_CONNECTION' | 'FIAT_ACCOUNT' | 'COMPOUND' | 'GAS_STATION' | 'ONE_TIME_ADDRESS' | 'UNKNOWN' | 'END_USER_WALLET' | 'PROGRAM_CALL' | 'MULTI_DESTINATION': Transfer peer type (source or destination) - `destSubType` 'EXTERNAL' | 'INTERNAL' | 'CONTRACT' | 'EXCHANGETEST': Transfer peer sub-type for prescreening rules - `transferPeerType` 'VAULT_ACCOUNT' | 'EXCHANGE_ACCOUNT' | 'INTERNAL_WALLET' | 'EXTERNAL_WALLET' | 'CONTRACT' | 'NETWORK_CONNECTION' | 'FIAT_ACCOUNT' | 'COMPOUND' | 'GAS_STATION' | 'ONE_TIME_ADDRESS' | 'UNKNOWN' | 'END_USER_WALLET' | 'PROGRAM_CALL' | 'MULTI_DESTINATION': Transfer peer type (source or destination) - `transferPeerSubType` 'EXTERNAL' | 'INTERNAL' | 'CONTRACT' | 'EXCHANGETEST': Transfer peer sub-type for prescreening rules - `destAddress` string: Destination address - `sourceId` string: Source ID - `destId` string: Destination ID - `asset` string: Asset identifier - `baseAsset` string: Base asset - `amount` number: Amount - `amountUSD` number: Amount in USD - `networkProtocol` string: Network protocol - `operation` 'TRANSFER' | 'BURN' | 'CONTRACT_CALL' | 'MINT' | 'RAW' | 'TYPED_MESSAGE' | 'ENABLE_ASSET' | 'STAKE' | 'UNSTAKE' | 'WITHDRAW' | 'REDEEM_FROM_COMPOUND' | 'SUPPLY_TO_COMPOUND' | 'PROGRAM_CALL' | 'APPROVE': Transaction operation type - `action` 'SCREEN' | 'BYPASS' | 'BLOCK' | 'PASS' | 'FREEZE': Travel rule action - `matchedNoTrmScreeningRule` object: Matched no-TRM (Travel Rule Message) screening rule details. Used when TRLink screening detects a missing TRM scenario. - `customerIntegrationId` string: Customer integration identifier used by Travel Rule providers - `customerShortName` string: Customer short name registered with Travel Rule providers - `travelRuleMessageId` string: Travel rule message identifier for linking and tracking across providers - `providerResponse` ScreeningProviderResponse: Complete response from the screening provider. This is a dynamic object that varies significantly between different providers (Chainalysis, Elliptic, NOTABENE, etc.). Each provider has their own proprietary response format and schema. For AML providers: Contains risk scores, alerts, entity information For Travel Rule providers: Contains VASP information, PII data, protocol-specific fields The structure is provider-dependent and cannot be standardized as each vendor implements their own proprietary data models and response formats. - `amlList` ComplianceScreeningResultFullPayload[]: The list of all results of the AML screening. - `provider` string: The AML/Travel Rule provider name. For AML: ELLIPTIC, CHAINALYSIS, etc. For Travel Rule: NOTABENE, SUMSUB, GTR, or any TRLink provider name - `payload` object: The raw payload of the screening result from the provider. The payload is a JSON object that contains the screening result. The payload structure is different for each screening provider. This field contains the complete, unmodified response from the screening service. - `timestamp` number: Unix timestamp in milliseconds when the screening result was generated - `screeningStatus` 'COMPLETED' | 'PENDING' | 'BYPASSED' | 'FAILED' | 'FROZEN': Current status of the screening process - `bypassReason` string: Reason for bypassing the screening, if applicable. For AML: UNSUPPORTED_ASSET, PASSED_BY_POLICY. For Travel Rule: UNSUPPORTED_ASSET, NO_TRAVEL_RULE_MESSAGE, TRANSACTION_ZERO_AMOUNT. - `status` 'COMPLETED' | 'PENDING' | 'BYPASSED' | 'FAILED' | 'FROZEN': Deprecated: Use screeningStatus instead. AML screening status. - `prevStatus` 'COMPLETED' | 'PENDING' | 'BYPASSED' | 'FAILED' | 'FROZEN': Deprecated: Use screeningStatus instead. AML screening status. - `prevBypassReason` string: Deprecated: This field is not currently returned in the API response. Previous bypass reason before the current bypass reason change. - `verdict` 'PASS' | 'FAIL' | 'ALERT' | 'REJECT' | 'WARN' | 'TRAVEL_RULE_REQUIRED' | 'ACCEPT' | 'REVIEW' | 'WAIT': The final verdict of the screening (unified for AML, Travel Rule, and TRLink). Different providers may return different verdict values: - AML: ACCEPT, REJECT, ALERT - Travel Rule: PASS, FAIL, TRAVEL_RULE_REQUIRED - TRLink: PASS, REJECT, WARN - `risk` string: Risk level assessment for screening results. Values vary by provider and are not managed by this service. Known values by provider: - Chainalysis: severeRisk, highRisk, mediumRisk, lowRisk, noRiskInfo - Elliptic: noRiskDetected Legacy values (SCREAMING_SNAKE_CASE, may appear in old transactions): VERY_HIGH, SEVERE, HIGH, MEDIUM, LOW, NO_RISK_INFO, UNKNOWN - `extendedRisk` string: Deprecated: This field is not currently returned in the API response. Use risk instead. - `externalId` string: External identifier for the screening (provider-specific) - `customerRefId` string: Customer-provided reference identifier for tracking - `refId` string: Deprecated: This field is not currently returned in the API response. Internal reference identifier. - `category` string: Risk category classification. Examples: EXCHANGE, GAMBLING, MIXER, DARKNET_SERVICE, SANCTIONED_ENTITY - `categoryId` number: Numeric identifier for the risk category - `destAddress` string: The destination blockchain address associated with the screening - `destTag` string: Destination tag or memo (for chains that support it like XRP, XLM) - `destRecordId` string: Deprecated: This field is not currently returned in the API response. The destination record identifier used by the screening provider. - `addressResolutionSignature` string: Deprecated: This field is not currently returned in the API response. Cryptographic signature for address resolution verification. - `amlResult` ScreeningAmlResult: Deprecated: This field is not currently returned in the API response. Detailed AML screening result information. Contains alerts, risk scores, and other AML-specific data from provider-specific responses. - `alerts` ScreeningAmlAlert[]: List of AML alerts triggered during screening - `alertLevel` 'SEVERE' | 'HIGH' | 'MEDIUM' | 'LOW', required: Alert level severity - `alertName` string: Name or type of the alert - `category` string: Alert category - `service` string: Service that generated the alert - `externalId` string, required: External identifier for the alert - `alertAmount` number, required: Amount associated with the alert - `exposureType` 'DIRECT' | 'INDIRECT', required: Alert exposure type - `policyAction` string: Recommended action based on policy - `categoryId` number: Category identifier - `providerResponse` object: Complete response from the AML provider. This is a dynamic object that varies significantly between different AML providers (Chainalysis, Elliptic, etc.). Each provider has their own proprietary response format and schema. Examples of provider-specific structures: - Chainalysis: Contains cluster info, risk scores, sanctions data - Elliptic: Includes risk assessment, entity types, compliance flags The structure is provider-dependent and cannot be standardized as each vendor implements their own proprietary data models and response formats. - `matchedRule` ScreeningAmlMatchedRule: AML matched rule information - `ruleId` string: Identifier of the matched rule - `ruleName` string: Name of the matched rule - `action` 'ALLOW' | 'BLOCK' | 'SCREEN' | 'ACCEPT' | 'REJECT' | 'ALERT' | 'WAIT' | 'FREEZE' | 'CANCEL': Policy verdict action - `matchedAlert` ScreeningAmlAlert: AML alert information - `alertLevel` 'SEVERE' | 'HIGH' | 'MEDIUM' | 'LOW', required: Alert level severity - `alertName` string: Name or type of the alert - `category` string: Alert category - `service` string: Service that generated the alert - `externalId` string, required: External identifier for the alert - `alertAmount` number, required: Amount associated with the alert - `exposureType` 'DIRECT' | 'INDIRECT', required: Alert exposure type - `policyAction` string: Recommended action based on policy - `categoryId` number: Category identifier - `result` ScreeningTravelRuleResult: Deprecated: This field is not currently returned in the API response. Detailed Travel Rule screening result containing provider-specific data. Contains Travel Rule specific information like verified status, rule type, and actions. - `direction` 'INBOUND' | 'OUTBOUND': Travel rule direction - `isVerified` boolean: Whether the travel rule information was verified - `action` 'ACCEPT' | 'REJECT' | 'ALERT' | 'REVIEW' | 'WAIT' | 'FREEZE' | 'CANCEL': The final verdict of the travel rule screening - `providerResponse` object: Complete response from the travel rule provider. This is a dynamic object that varies significantly between different travel rule providers (NOTABENE etc.). Each provider has their own proprietary response format and schema. Examples of provider-specific structures: - NOTABENE: Contains VASP information, PII data, protocol-specific fields The structure is provider-dependent and cannot be standardized as each vendor implements their own proprietary data models and response formats. - `matchedRule` ScreeningTravelRuleMatchedRule: The travel rule configuration that was matched - `direction` 'INBOUND' | 'OUTBOUND': Travel rule direction - `status` 'COMPLETED' | 'PENDING' | 'BYPASSED' | 'FAILED' | 'FROZEN' | 'REJECTED' | 'CANCELED' | 'BLOCKING_TIME_EXPIRED': Travel rule status - `amountUSD` number: Amount in USD - `amount` number: Amount in base currency - `asset` string: Asset identifier - `action` 'ACCEPT' | 'REJECT' | 'ALERT' | 'REVIEW' | 'WAIT' | 'FREEZE' | 'CANCEL': The final verdict of the travel rule screening - `detailsMessage` string: Additional human-readable details or message about the screening result - `matchedAlert` object: Information about the AML alert that was matched, if any. Contains details about the specific alert that triggered during screening. - `matchedRule` object: The matched rule information for this screening result. Contains details about which screening rule was applied and matched. - `matchedPrescreeningRule` ScreeningTravelRulePrescreeningRule: Matched prescreening rule details. Prescreening rules are evaluated before the main screening to determine if screening is necessary or should be bypassed. - `bypassReason` string: Reason for bypass if prescreening rule triggered a bypass - `sourceType` 'VAULT_ACCOUNT' | 'EXCHANGE_ACCOUNT' | 'INTERNAL_WALLET' | 'EXTERNAL_WALLET' | 'CONTRACT' | 'NETWORK_CONNECTION' | 'FIAT_ACCOUNT' | 'COMPOUND' | 'GAS_STATION' | 'ONE_TIME_ADDRESS' | 'UNKNOWN' | 'END_USER_WALLET' | 'PROGRAM_CALL' | 'MULTI_DESTINATION': Transfer peer type (source or destination) - `sourceSubType` 'EXTERNAL' | 'INTERNAL' | 'CONTRACT' | 'EXCHANGETEST': Transfer peer sub-type for prescreening rules - `destType` 'VAULT_ACCOUNT' | 'EXCHANGE_ACCOUNT' | 'INTERNAL_WALLET' | 'EXTERNAL_WALLET' | 'CONTRACT' | 'NETWORK_CONNECTION' | 'FIAT_ACCOUNT' | 'COMPOUND' | 'GAS_STATION' | 'ONE_TIME_ADDRESS' | 'UNKNOWN' | 'END_USER_WALLET' | 'PROGRAM_CALL' | 'MULTI_DESTINATION': Transfer peer type (source or destination) - `destSubType` 'EXTERNAL' | 'INTERNAL' | 'CONTRACT' | 'EXCHANGETEST': Transfer peer sub-type for prescreening rules - `transferPeerType` 'VAULT_ACCOUNT' | 'EXCHANGE_ACCOUNT' | 'INTERNAL_WALLET' | 'EXTERNAL_WALLET' | 'CONTRACT' | 'NETWORK_CONNECTION' | 'FIAT_ACCOUNT' | 'COMPOUND' | 'GAS_STATION' | 'ONE_TIME_ADDRESS' | 'UNKNOWN' | 'END_USER_WALLET' | 'PROGRAM_CALL' | 'MULTI_DESTINATION': Transfer peer type (source or destination) - `transferPeerSubType` 'EXTERNAL' | 'INTERNAL' | 'CONTRACT' | 'EXCHANGETEST': Transfer peer sub-type for prescreening rules - `destAddress` string: Destination address - `sourceId` string: Source ID - `destId` string: Destination ID - `asset` string: Asset identifier - `baseAsset` string: Base asset - `amount` number: Amount - `amountUSD` number: Amount in USD - `networkProtocol` string: Network protocol - `operation` 'TRANSFER' | 'BURN' | 'CONTRACT_CALL' | 'MINT' | 'RAW' | 'TYPED_MESSAGE' | 'ENABLE_ASSET' | 'STAKE' | 'UNSTAKE' | 'WITHDRAW' | 'REDEEM_FROM_COMPOUND' | 'SUPPLY_TO_COMPOUND' | 'PROGRAM_CALL' | 'APPROVE': Transaction operation type - `action` 'SCREEN' | 'BYPASS' | 'BLOCK' | 'PASS' | 'FREEZE': Travel rule action - `matchedNoTrmScreeningRule` object: Matched no-TRM (Travel Rule Message) screening rule details. Used when TRLink screening detects a missing TRM scenario. - `customerIntegrationId` string: Customer integration identifier used by Travel Rule providers - `customerShortName` string: Customer short name registered with Travel Rule providers - `travelRuleMessageId` string: Travel rule message identifier for linking and tracking across providers - `providerResponse` ScreeningProviderResponse: Complete response from the screening provider. This is a dynamic object that varies significantly between different providers (Chainalysis, Elliptic, NOTABENE, etc.). Each provider has their own proprietary response format and schema. For AML providers: Contains risk scores, alerts, entity information For Travel Rule providers: Contains VASP information, PII data, protocol-specific fields The structure is provider-dependent and cannot be standardized as each vendor implements their own proprietary data models and response formats. - `status` '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': Status of compliance result screening - `amlRegistration` AmlRegistrationResultFullPayload: The results of the AML address registration. - `provider` string - `success` boolean - `timestamp` number - `trlinkRegistration` TRLinkRegistrationResultFullPayload: TRLink registration result containing status and metadata - `status` 'STARTING' | 'PRESCREENED' | 'COMPLETED' | 'FAILED' | 'VOID', required: TRLink registration status - `provider` string: The TRLink provider name - `success` boolean: Whether the registration was successful - `timestamp` number, required: Unix timestamp of the registration - `destRecordId` string: Destination record identifier - `travelRuleMessageId` string: Travel rule message identifier for linking - `customerIntegrationId` string: Customer integration identifier - `customerShortName` string: Customer short name - `result` TRLinkProviderResult: Provider-specific response data wrapper - `providerResponse` object: Raw provider response - `matchedPrescreeningRule` ScreeningTRLinkPrescreeningRule: Base interface for TRLink policy rules - `customerId` string: Reference to TRLinkCustomer.id - `direction` 'INBOUND' | 'OUTBOUND': Travel rule direction - `sourceType` 'VAULT_ACCOUNT' | 'EXCHANGE_ACCOUNT' | 'INTERNAL_WALLET' | 'EXTERNAL_WALLET' | 'CONTRACT' | 'NETWORK_CONNECTION' | 'FIAT_ACCOUNT' | 'COMPOUND' | 'GAS_STATION' | 'ONE_TIME_ADDRESS' | 'UNKNOWN' | 'END_USER_WALLET' | 'PROGRAM_CALL' | 'MULTI_DESTINATION': Transfer peer type (source or destination) - `sourceSubType` 'EXTERNAL' | 'INTERNAL' | 'CONTRACT' | 'EXCHANGETEST': Transfer peer sub-type for prescreening rules - `sourceAddress` string: Source address - `destType` 'VAULT_ACCOUNT' | 'EXCHANGE_ACCOUNT' | 'INTERNAL_WALLET' | 'EXTERNAL_WALLET' | 'CONTRACT' | 'NETWORK_CONNECTION' | 'FIAT_ACCOUNT' | 'COMPOUND' | 'GAS_STATION' | 'ONE_TIME_ADDRESS' | 'UNKNOWN' | 'END_USER_WALLET' | 'PROGRAM_CALL' | 'MULTI_DESTINATION': Transfer peer type (source or destination) - `destSubType` 'EXTERNAL' | 'INTERNAL' | 'CONTRACT' | 'EXCHANGETEST': Transfer peer sub-type for prescreening rules - `destAddress` string: Destination address - `sourceId` string: Source ID - `destId` string: Destination ID - `asset` string: Asset symbol - `baseAsset` string: Base asset symbol - `amount` ScreeningTRLinkAmount: TRLink amount definition with range and currency, compatible with TAP format from Policy Engine V2 - `range` AmountRangeMinMax: Amount range with minimum and maximum values - `min` string: Minimum amount - `max` string: Maximum amount - `currency` 'USD' | 'NATIVE': Currency type - `networkProtocol` string: Network protocol - `operation` 'TRANSFER' | 'BURN' | 'CONTRACT_CALL' | 'MINT' | 'RAW' | 'TYPED_MESSAGE' | 'ENABLE_ASSET' | 'STAKE' | 'UNSTAKE' | 'WITHDRAW' | 'REDEEM_FROM_COMPOUND' | 'SUPPLY_TO_COMPOUND' | 'PROGRAM_CALL' | 'APPROVE': Transaction operation type - `description` string: Rule description - `isDefault` boolean: Whether this is a default rule - `action` 'SCREEN' | 'PASS', required: TRLink pre-screening action - `trlinkDestinations` TRLinkResultFullPayload[]: The list of TRLink destination screening results. - `provider` string, required: The TRLink provider name - `timestamp` number, required: Unix timestamp of the screening result - `status` 'COMPLETED' | 'PENDING' | 'BYPASSED' | 'FAILED' | 'FROZEN', required: Status of the TRLink screening - `verdict` 'ACCEPT' | 'ALERT' | 'REJECT' | 'WAIT': TRLink verdict after screening - `destAddress` string: The destination address associated with the TRLink screening - `destTag` string: Destination tag for the screening - `bypassReason` string: Reason for bypassing the TRLink screening - `detailsMessage` string: Additional details message about the screening result - `customerIntegrationId` string: Customer integration identifier - `customerShortName` string: Customer short name - `travelRuleMessageId` string: Travel rule message identifier for linking - `result` TRLinkProviderResultWithRule2: Provider response and matched rule wrapper for TRLink screening results - `providerResponse` object: Raw provider response - `matchedRule` ScreeningTRLinkPostScreeningRule: Base interface for TRLink policy rules - `customerId` string: Reference to TRLinkCustomer.id - `direction` 'INBOUND' | 'OUTBOUND': Travel rule direction - `sourceType` 'VAULT_ACCOUNT' | 'EXCHANGE_ACCOUNT' | 'INTERNAL_WALLET' | 'EXTERNAL_WALLET' | 'CONTRACT' | 'NETWORK_CONNECTION' | 'FIAT_ACCOUNT' | 'COMPOUND' | 'GAS_STATION' | 'ONE_TIME_ADDRESS' | 'UNKNOWN' | 'END_USER_WALLET' | 'PROGRAM_CALL' | 'MULTI_DESTINATION': Transfer peer type (source or destination) - `sourceSubType` 'EXTERNAL' | 'INTERNAL' | 'CONTRACT' | 'EXCHANGETEST': Transfer peer sub-type for prescreening rules - `sourceAddress` string: Source address - `destType` 'VAULT_ACCOUNT' | 'EXCHANGE_ACCOUNT' | 'INTERNAL_WALLET' | 'EXTERNAL_WALLET' | 'CONTRACT' | 'NETWORK_CONNECTION' | 'FIAT_ACCOUNT' | 'COMPOUND' | 'GAS_STATION' | 'ONE_TIME_ADDRESS' | 'UNKNOWN' | 'END_USER_WALLET' | 'PROGRAM_CALL' | 'MULTI_DESTINATION': Transfer peer type (source or destination) - `destSubType` 'EXTERNAL' | 'INTERNAL' | 'CONTRACT' | 'EXCHANGETEST': Transfer peer sub-type for prescreening rules - `destAddress` string: Destination address - `sourceId` string: Source ID - `destId` string: Destination ID - `asset` string: Asset symbol - `baseAsset` string: Base asset symbol - `amount` ScreeningTRLinkAmount: TRLink amount definition with range and currency, compatible with TAP format from Policy Engine V2 - `range` AmountRangeMinMax: Amount range with minimum and maximum values - `min` string: Minimum amount - `max` string: Maximum amount - `currency` 'USD' | 'NATIVE': Currency type - `networkProtocol` string: Network protocol - `operation` 'TRANSFER' | 'BURN' | 'CONTRACT_CALL' | 'MINT' | 'RAW' | 'TYPED_MESSAGE' | 'ENABLE_ASSET' | 'STAKE' | 'UNSTAKE' | 'WITHDRAW' | 'REDEEM_FROM_COMPOUND' | 'SUPPLY_TO_COMPOUND' | 'PROGRAM_CALL' | 'APPROVE': Transaction operation type - `description` string: Rule description - `isDefault` boolean: Whether this is a default rule - `providerIdent` string: Provider identifier - `trmStatus` 'PENDING' | 'ACCEPTED' | 'REJECTED' | 'FAILED': TRLink TRM screening status - `validBefore` number: Rule expires once this many seconds have elapsed since the wait/screening step started - `validAfter` number: Rule applies only after this many seconds have elapsed since the wait/screening step started - `action` 'ACCEPT' | 'ALERT' | 'REJECT' | 'WAIT', required: TRLink verdict after screening - `matchedPrescreeningRule` ScreeningTRLinkPrescreeningRule: Base interface for TRLink policy rules - `customerId` string: Reference to TRLinkCustomer.id - `direction` 'INBOUND' | 'OUTBOUND': Travel rule direction - `sourceType` 'VAULT_ACCOUNT' | 'EXCHANGE_ACCOUNT' | 'INTERNAL_WALLET' | 'EXTERNAL_WALLET' | 'CONTRACT' | 'NETWORK_CONNECTION' | 'FIAT_ACCOUNT' | 'COMPOUND' | 'GAS_STATION' | 'ONE_TIME_ADDRESS' | 'UNKNOWN' | 'END_USER_WALLET' | 'PROGRAM_CALL' | 'MULTI_DESTINATION': Transfer peer type (source or destination) - `sourceSubType` 'EXTERNAL' | 'INTERNAL' | 'CONTRACT' | 'EXCHANGETEST': Transfer peer sub-type for prescreening rules - `sourceAddress` string: Source address - `destType` 'VAULT_ACCOUNT' | 'EXCHANGE_ACCOUNT' | 'INTERNAL_WALLET' | 'EXTERNAL_WALLET' | 'CONTRACT' | 'NETWORK_CONNECTION' | 'FIAT_ACCOUNT' | 'COMPOUND' | 'GAS_STATION' | 'ONE_TIME_ADDRESS' | 'UNKNOWN' | 'END_USER_WALLET' | 'PROGRAM_CALL' | 'MULTI_DESTINATION': Transfer peer type (source or destination) - `destSubType` 'EXTERNAL' | 'INTERNAL' | 'CONTRACT' | 'EXCHANGETEST': Transfer peer sub-type for prescreening rules - `destAddress` string: Destination address - `sourceId` string: Source ID - `destId` string: Destination ID - `asset` string: Asset symbol - `baseAsset` string: Base asset symbol - `amount` ScreeningTRLinkAmount: TRLink amount definition with range and currency, compatible with TAP format from Policy Engine V2 - `range` AmountRangeMinMax: Amount range with minimum and maximum values - `min` string: Minimum amount - `max` string: Maximum amount - `currency` 'USD' | 'NATIVE': Currency type - `networkProtocol` string: Network protocol - `operation` 'TRANSFER' | 'BURN' | 'CONTRACT_CALL' | 'MINT' | 'RAW' | 'TYPED_MESSAGE' | 'ENABLE_ASSET' | 'STAKE' | 'UNSTAKE' | 'WITHDRAW' | 'REDEEM_FROM_COMPOUND' | 'SUPPLY_TO_COMPOUND' | 'PROGRAM_CALL' | 'APPROVE': Transaction operation type - `description` string: Rule description - `isDefault` boolean: Whether this is a default rule - `action` 'SCREEN' | 'PASS', required: TRLink pre-screening action - `matchedNoTrmScreeningRule` ScreeningTRLinkMissingTrmDecision: Base interface for TRLink policy rules - `customerId` string: Reference to TRLinkCustomer.id - `direction` 'INBOUND' | 'OUTBOUND': Travel rule direction - `sourceType` 'VAULT_ACCOUNT' | 'EXCHANGE_ACCOUNT' | 'INTERNAL_WALLET' | 'EXTERNAL_WALLET' | 'CONTRACT' | 'NETWORK_CONNECTION' | 'FIAT_ACCOUNT' | 'COMPOUND' | 'GAS_STATION' | 'ONE_TIME_ADDRESS' | 'UNKNOWN' | 'END_USER_WALLET' | 'PROGRAM_CALL' | 'MULTI_DESTINATION': Transfer peer type (source or destination) - `sourceSubType` 'EXTERNAL' | 'INTERNAL' | 'CONTRACT' | 'EXCHANGETEST': Transfer peer sub-type for prescreening rules - `sourceAddress` string: Source address - `destType` 'VAULT_ACCOUNT' | 'EXCHANGE_ACCOUNT' | 'INTERNAL_WALLET' | 'EXTERNAL_WALLET' | 'CONTRACT' | 'NETWORK_CONNECTION' | 'FIAT_ACCOUNT' | 'COMPOUND' | 'GAS_STATION' | 'ONE_TIME_ADDRESS' | 'UNKNOWN' | 'END_USER_WALLET' | 'PROGRAM_CALL' | 'MULTI_DESTINATION': Transfer peer type (source or destination) - `destSubType` 'EXTERNAL' | 'INTERNAL' | 'CONTRACT' | 'EXCHANGETEST': Transfer peer sub-type for prescreening rules - `destAddress` string: Destination address - `sourceId` string: Source ID - `destId` string: Destination ID - `asset` string: Asset symbol - `baseAsset` string: Base asset symbol - `amount` ScreeningTRLinkAmount: TRLink amount definition with range and currency, compatible with TAP format from Policy Engine V2 - `range` AmountRangeMinMax: Amount range with minimum and maximum values - `min` string: Minimum amount - `max` string: Maximum amount - `currency` 'USD' | 'NATIVE': Currency type - `networkProtocol` string: Network protocol - `operation` 'TRANSFER' | 'BURN' | 'CONTRACT_CALL' | 'MINT' | 'RAW' | 'TYPED_MESSAGE' | 'ENABLE_ASSET' | 'STAKE' | 'UNSTAKE' | 'WITHDRAW' | 'REDEEM_FROM_COMPOUND' | 'SUPPLY_TO_COMPOUND' | 'PROGRAM_CALL' | 'APPROVE': Transaction operation type - `description` string: Rule description - `isDefault` boolean: Whether this is a default rule - `validBefore` number: Rule expires once this many seconds have elapsed since the wait/screening step started - `validAfter` number: Rule applies only after this many seconds have elapsed since the wait/screening step started - `action` 'WAIT' | 'REJECT' | 'ACCEPT' | 'INITIATE_TRM', required: TRLink missing TRM action - `source` string, required: TRLink missing TRM source - `timestamp` string, date-time: Timestamp of the decision - `reason` string: Reason for the decision ## Other responses - `default`: Error Response --- [API](https://skmtc.dev/fireblocks/apis/fireblocks-api.md) - [All operations](https://skmtc.dev/fireblocks/apis/fireblocks-api/llms.txt) - [OpenAPI document](https://skmtc.dev/fireblocks/apis/fireblocks-api/revisions/4eba9965659a?raw)