We refreshed our doc site!

Bookmarked links may have changed

Read release notes

Web3 Services

Rule Management

Your transaction screening rules are the rules against which your screening events (embedded or address) will be evaluated. They will contain the rule criteria that will trigger the rule as well as the applicable or suggested actions for each rule if triggered. For Testnet, there are a number of default rules in place which you can use to test against (see Testing Guide).

Rule Configurations

There are two types of rules for Transaction Screening which can be configured: Restrictive Rules and Alert-only Rules.

A rule consists of the following:

  1. Name: This is auto generated based on the rule criteria and actions.
  2. Description: This is an optional text field to provide a summary of what the rule is designed to accomplish.
  3. Actions: What actions should be applied or suggested when a rule is matched. There are two distinct rule types, Restrictive and Alert-only, for which the following actions are associated:
    a. Transaction Decision: this action allows you to prevent outgoing transactions from being broadcast. It is available as a restrictive rule only.
    b. Wallet Freeze: this action allows you to freeze the funds in the associated programmable wallet. It is available as a restrictive rule only.
    c. Generate an Alert: this action will trigger the generation of an alert in your Alerts Table within the Console. This is optional on restrictive rules but mandatory on alert-only rules.
  4. Rule Criteria: What combination of risk signals should a rule alert on. There are three unique criteria to be set with each rule:
    a. Risk Category: general categorization of the risk that has been flagged for the entity in question.
    b. Risk Score: representative value for the level of risk associated with the entity.
    c. Risk Type: level of exposure for the risk involved. Is the address directly or indirectly associated with the risk?

Mandatory Rules

There are a number of rules in place by default that have minimal configuration options, e.g. the ability to toggle the alert action. These rules are as follows:

  • Circle’s Sanctions Blocklist. This rule is in line with the mandatory Compliance Requirements you must adhere to when using programmable wallets. Wallets and transactions will be restricted if they are detected sending or receiving from any OFAC-sanctioned address.
  • Your blocklist. This rule relates to the Watchlists functionality.
  • Frozen. This rule is used to enforce the wallet freeze, which is applied to wallets by other transaction screening rules, or via the developer console.
  • Your allowlist. This rule relates to the Watchlists functionality.

Configurable Rule Criteria Combinations

The table below outlines all possible criteria combinations that can be used to create/configure rules.

SymbolMeaning
Default Combination in place on Mainnet. Configurable.
🟡Possible Combination that can be utilized in a configurable rule.
Unsupported combination, a screening cannot result in this possible combination of criteria.

Risk CategoryRisk TypeRisk Score
SevereHighMediumLow
SanctionsOwnership
SanctionsCounterparty🟡
SanctionsIndirect🟡
Terrorist FinancingOwnership🟡
Terrorist FinancingCounterparty🟡🟡
Terrorist FinancingIndirect🟡🟡
CSAMOwnership
CSAMCounterparty🟡
CSAMIndirect🟡
PEPOwnership🟡
PEPCounterparty🟡
PEPIndirect🟡
GamblingOwnership
GamblingCounterparty🟡
GamblingIndirect🟡
Illicit BehaviorOwnership🟡🟡🟡
Illicit BehaviorCounterparty🟡🟡🟡
Illicit BehaviorIndirect🟡🟡🟡
High Risk IndustryOwnership🟡🟡
High Risk IndustryCounterparty🟡🟡
High Risk IndustryIndirect🟡
OtherOwnership🟡🟡
OtherCounterparty🟡🟡🟡
OtherIndirect🟡🟡

Rule Setup

To create or edit a rule, follow these steps:

  1. Access Settings page: Using your credentials, log in to the Circle Console. From there, navigate to the Compliance Engine > Settings section, which allows you to manage your screening rules conveniently.
  2. Choose to create or edit a rule: Select the appropriate rule type Configurable restrictive rules or Configurable alert-only rules. To edit an existing rule, select the rule in question and click the Edit button. To add a new rule, select Add Rule.
  3. Configure the rule: Set the desired rule (description, actions, and criteria) based on your requirements. Refer to the above possible configurations for clarity on the available options.
  4. Update or create the rule: After applying the necessary configurations, select either:
    • Save to modify an existing rule; or
    • Create Rule button (top-right of page) to create a new rule.

Deactivating a Rule

New rules will be created in an active state by default. If you need to temporarily deactivate a rule, you can do so as follows:

  1. Select the rule. Using your credentials, log in to the Circle Console. From there, navigate to the Compliance Engine > Settings section, select the rule you wish to change, and select the Edit button.
  2. Toggle the Rule Status. Rule status is located at the bottom of the page. Just toggle the Rule Status from Active to Inactive.
  3. Save change.

Deleting a Rule

If you need to permanently delete a rule, you can do so as follows:

  1. Select the rule. Using your credentials, log in to the Circle Console. From there, navigate to the Compliance Engine > Settings section, select the rule you wish to change.
  2. Delete the rule. Select the Delete button twice.

Watchlists

Another method for influencing your rule configuration is via the Watchlists feature. You can influence the screening evaluations by adding blockchain addresses to either the Blocklist or the Allowlist.

These lists act as the inputs for two of your default rules:

  • Your blocklist will deny any transaction where the associated address has been added to your blocklist.
  • Your allowlist will allow any transaction where the associated address has been added to your allowlist.

To add an address to either your allowlist or your blocklist:

  1. Access the Watchlists page. Using your credentials log into the Circle Console. Navigate to the Watchlists page under the Compliance Engine.
  2. Choose the appropriate list. Select the appropriate tab between Blocklist and Allowlist for your desired outcome.
  3. Add entry. Select the Add Entry button on the top right. Enter the blockchain address, choose the reason, and leave an optional note explaining the addition.
Did this page help you?
© 2023-2024 Circle Technology Services, LLC. All rights reserved.