{
"id": "<string>",
"name": "<string>",
"status": "Active",
"activityKind": "Registry:Addresses:Modify",
"rule": {
"kind": "AlwaysTrigger",
"configuration": {}
},
"action": {
"kind": "RequestApproval",
"approvalGroups": [
{
"quorum": 2,
"approvers": {
"userId": {
"in": [
"<string>"
]
}
},
"name": "<string>",
"initiatorCanApprove": true
}
],
"autoRejectTimeout": 2
},
"dateCreated": "<string>",
"dateUpdated": "<string>",
"filters": {}
}Skipped if the rule did not apply or is triggered executing the associated action. If the action is RequestApproval, an Approval process is initiated.
AlwaysTrigger rule and Block action, then create separate policies for allowed cases.Wallets:Sign, Permissions:Assign, Permissions:Modify , Policies:Modify.
Wallets:Sign activityWallets:Sign” activity represents any activity which involves signing with a wallet. Currently, in our API, these can be:
Wallets:IncomingTransaction activityWallets:IncomingTransaction” activity represents when our indexers detected an incoming transaction into a wallet. This activity kind has to be used with the rule kind “ChainalysisTransactionScreening” (see more on Chainalysis integration page), and the action kind “NoAction”, meaning that no actual action will be taken as a result of the Chainalysis screening, other than notifying you through a webhook event if the policy is triggered. The reason for that, is that the incoming transaction is already on-chain, so the funds are already in the wallet, we cannot block that transfer on chain.
Permissions:Modify activityPermissions:Modify” activity represents any activity which involves updating or archiving a permission. These activities are Permission change requests, created as a result of calling either:
Permissions:Assign activityPermissions:Assign” activity represents any activity which involves assigning a permission (or revoking it, aka “deleting a permission assignment”). These activities are Assignment change requests, created as a result of calling either:
Policies:Modify activityPolicies:Modify” activity represents any activity which involves updating or archiving a policy. These activities are Policy change requests, created as a result of calling either:
AlwaysTrigger, TransactionAmountLimit, TransactionAmountVelocity, TransactionCountVelocity, TransactionRecipientWhitelist, ChainalysisTransactionPrescreening, ChainalysisTransactionScreening, GlobalLedgerTransactionPrescreening, TravelRuleTransactionPrescreening.
AlwaysTrigger policy ruleactivityKind. It will always be triggered, meaning that if this rule is defined on a policy, the policy will always trigger the policy action, regardless of the activity details.
{
"rule": {
"kind": "AlwaysTrigger",
}
}
TransactionAmountLimit policy ruleactivityKind = Wallets:Sign. It will trigger if the wallet activity detected is transferring some value which amount is greater than a given limit.
{
"rule": {
"kind": "TransactionAmountLimit",
"configuration": {
"limit": 1000,
"currency": "USD",
},
}
}
| Property | Type | Description |
|---|---|---|
| limit* | Positive Integer | Amount limit in currency |
| currency* | String | Fiat currency, currently only USD |
TransactionAmountVelocity policy ruleactivityKind = Wallets:Sign. It will trigger if the cumulative amount transferred from a given wallet within a given timeframe is greater than a specified limit. The aggregate amount evaluated is based only on the wallet that triggered the policy.
{
"rule": {
"kind": "TransactionAmountVelocity",
"configuration": {
"limit": 1000,
"currency": "USD",
"timeframe": 60,
},
},
}
| Property | Type | Description |
|---|---|---|
| limit* | Positive Integer | Amount limit in currency |
| currency* | String | Fiat currency, currently only USD |
| timeframe* | Positive Integer | Time period in minutes. Minimum 1, Maximum 43,200. |
TransactionCountVelocity policy ruleactivityKind = Wallets:Sign. It will trigger if the number of wallet activities for a given wallet within a given timeframe, is greater than a specified limit. The aggregate number of transactions evaluated is based only on the wallet that triggered the policy.
{
"rule": {
"kind": "TransactionCountVelocity",
"configuration": {
"limit": 5,
"timeframe": 60,
},
},
}
| Property | Type | Description |
|---|---|---|
| limit* | Positive Integer | Amount limit in currency |
| timeframe* | Positive Integer | Time period in minutes. Minimum 1, Maximum 43,200. |
TransactionRecipientWhitelist policy ruleactivityKind = Wallets:Sign. It will trigger if the wallet activity transfers some value to a recipient and the destination address is NOT whitelisted.
{
"rule": {
"kind": "TransactionRecipientWhitelist",
"configuration": {
"addresses": ["0x...1", "0x...2"],
},
}
}
| Property | Type | Description |
|---|---|---|
| addresses* | List of Strings | Whitelisted recipient addresses |
ChainalysisTransactionPrescreening policy ruleactivityKind = Wallets:Sign. It’s a rule based on Chainalysis KYT integration (Know-Your-Transaction). Upon transfer attempt, we will first register the transfer with Chainalysis (as a “withdrawal attempt”), and fetch the screening results (alerts, exposures, addresses detected). Based on the results, and the configuration of this rule, the policy will be triggered.
It’s called “Pre”-screening, because the scanned transaction is not on chain yet, it’s still a transaction attempt (before the transaction actually make it on chain).
{
"rule": {
"kind": "ChainalysisTransactionPrescreening",
"configuration": {
"alerts": {
"alertLevel": "LOW",
"categoryIds": []
},
"exposures": {
"direct": {
"categoryIds": []
}
},
"addresses": {
"categoryIds": []
},
"fallbackBehaviours": {
"skipUnscreenableTransaction": false,
"skipUnsupportedNetwork": false,
"skipUnsupportedAsset": false,
"skipChainalysisFailure": false
}
}
}
}
| Property | Type | Description |
|---|---|---|
alerts.alertLevel* | string | Minimum alert level above which the rule should trigger, if any alert is returned in Chainalysis results. Can be LOW, MEDIUM, HIGH, or SEVERE |
alerts.categoryIds* | list of integers | List of Chainalysis category IDs (see here). If you leave this list empty, alerts of any category will trigger the rule. Otherwise, if you only want the rule to trigger on specific categories, you can specify some in the list. |
exposures.direct.categoryIds* | list of integers | List of Chainalysis category IDs (see here). If you leave this list empty, a direct exposure of any category detected by chainalysis will trigger the rule. Otherwise, if you only want the rule to trigger on specific categories, you can specify some in the list. |
addresses.categoryIds* | list of integers | List of Chainalysis category IDs (see here). If you leave this list empty, an address of any category identified by chainalysis will trigger the rule. Otherwise, if you only want the rule to trigger on specific categories, you can specify some in the list. |
fallbackBehaviours.skipUnscreenableTransaction* | boolean | Behaviour if the wallet activity is not screenable (eg. if it’s a signature request of a hash). If true, a transaction which is “unscreenable” will just be skipped, and policy will not trigger |
fallbackBehaviours.skipUnsupportedNetwork* | boolean | Behaviour if the wallet activity is on a network not supported by chainalysis, or not yet supported in the dfns-chainalysis integration. If true, an unsupported network will just be skipped, and policy will not trigger |
fallbackBehaviours.skipUnsupportedAsset* | boolean | Behaviour if the wallet activity is with a asset not supported by chainalysis, or not yet supported in the dfns-chainalysis integration. If true, an unsupported asset will just be skipped, and policy will not trigger |
fallbackBehaviours.skipChainalysisFailure* | boolean | Behaviour if any issue with Chainalysis calls (timeout, results took too long, rate limiting errors, any error). If true, will skip if any error happens |
ChainalysisTransactionScreening policy ruleactivityKind = Wallets:IncomingTransaction, and with the action kind NoAction. It’s a rule based on Chainalysis KYT integration (Know-Your-Transaction). Upon an incoming transaction detectedby our indexers, we will register the transfer with Chainalysis, and fetch the results of the analysis (alerts & exposures detected). Based on the results, and the configuration of this rule, the policy will be triggered.
The shape of the rule is almost like the ChainalysisTransactionPrescreening rule, expect the the address property is not supported.
{
"rule": {
"kind": "ChainalysisTransactionPrescreening",
"configuration": {
"alerts": {
"alertLevel": "LOW",
"categoryIds": []
},
"exposures": {
"direct": {
"categoryIds": []
}
},
"fallbackBehaviours": {
"skipUnscreenableTransaction": false,
"skipUnsupportedNetwork": false,
"skipUnsupportedAsset": false,
"skipChainalysisFailure": false
}
}
}
}
ChainalysisTransactionPrescreening
GlobalLedgerTransactionPrescreening policy ruleactivityKind = Wallets:Sign. It’s a rule based on Global Ledger KYT integration (Know-Your-Transaction). Upon transfer attempt, we will send the transaction to Global Ledger for screening and fetch the risk score and any alerts. Based on the results, and the configuration of this rule, the policy will be triggered.
The policy triggers when either:
riskScoreThreshold{
"rule": {
"kind": "GlobalLedgerTransactionPrescreening",
"configuration": {
"riskScoreThreshold": 70,
"fallbackBehaviours": {
"skipUnscreenableTransaction": false,
"skipUnsupportedNetwork": false,
"skipUnsupportedAsset": false,
"skipGlobalLedgerFailure": false
}
}
}
}
| Property | Type | Description |
|---|---|---|
riskScoreThreshold* | integer (0-100) | Risk score threshold. If the transaction’s risk score meets or exceeds this value, the policy triggers. 0 = lowest risk, 100 = highest risk. |
fallbackBehaviours.skipUnscreenableTransaction* | boolean | If true, skip wallet requests that cannot be screened (e.g., raw signature requests) instead of triggering the policy. |
fallbackBehaviours.skipUnsupportedNetwork* | boolean | If true, skip transfers to networks not supported by the Global Ledger integration instead of triggering the policy. |
fallbackBehaviours.skipUnsupportedAsset* | boolean | If true, skip transfers of assets not supported by the Global Ledger integration instead of triggering the policy. |
fallbackBehaviours.skipGlobalLedgerFailure* | boolean | If true, skip when the Global Ledger API request fails (timeout, rate limiting, errors) instead of triggering the policy. |
TravelRuleTransactionPrescreening policy ruleactivityKind = Wallets:Sign,and with the action kind Block. It’s a rule based on Notabene TravelRule integration. It ONLY applies to Dfns Transfer Asset Api Calls. It is NOT supported for Transfers initiated via the dashboard. Upon transfer attempt with an optional TravelRule payload, we will call Notabene’s APIs on your behalf to both confirm the validity of the travel rule message and submit it for processing. Dfns then waits for a response from the counterparty (for custodial transfers) or Notabene (for non-custodial transfers).
It’s called “Pre”-screening, because the transaction is not on chain yet, it’s still a transaction attempt (before the transaction actually make it on chain).
{
"kind": "TravelRuleTransactionPrescreening",
"configuration": {
"vendor": "Notabene",
"autoTriggerTimeoutSeconds": 300,
"autoClearAfterDeliveredTimeoutSeconds": 200
}
}
| Property | Type | Description |
|---|---|---|
| vendor | string | TravelRule vendor to use for the prescreening policy. At the moment we only support Notabene. |
| autoTrigger TimeoutSeconds | Positive Integer | If we do NOT receive any updates from Notabene regarding the status of the travel rule message we need to eventually time out and reject the transfer. This is the timeout, in seconds, we wait for a response from Notabene before rejecting the transfer. |
| autoClearAfterDelivered TimeoutSeconds | Positive Integer(Optional) | This OPTIONAL setting allows you to proceed with a transfer that Notabene has delivered to a counterparty even if the recipient hasn’t responded after delivery. |
BlockandRequestApproval.
Block policy action{
"action": {
"kind": "Block"
}
}
RequestApproval policy actionRequestApproval action, configured with one approval group requiring 2 approvals amongst three specific users.
{
"action": {
"kind": "RequestApproval",
"autoRejectTimeout": 60, // minutes
"approvalGroups": [
{
"name": "Admins",
"quorum": 2, // only 2 approvers required in that group
"approvers": {
"userId": {
"in": ["us-...1", "us-...2", "us-...3"],
}
},
"initiatorCanApprove": false,
}
],
}
}
| property | Type | Description |
|---|---|---|
| approvalGroups* | List of Object | List of approval groups. If multiple groups are defined, the approval is complete only when all groups have approved |
| approvalGroups[].name | (Optional) String | Optional name of this group. |
| approvalGroups[].quorum* | Positive Integer | The quorum is the number of approvals required in this group to reach group consensus. The activity is executed only if all groups reached their approval quorum. |
| approvalGroups[].approvers* | Object | Defines all users that are allowed to approve in the group. If set to an empty object {}, it means that anyone within your organisation can be an approver. Otherwise, you can specify an exact list of allowed approvers, by adding their user IDs in this object: { userId: { in: [...] }} |
| approvalGroups[].initiatorCanApprove | (Optional) Boolean | Whether the initiator of the activity can participate in the approval (defaults to false) |
| autoRejectTimeout | (Optional) Positive Integer | Number of minutes after which, if the approval has not reach global consensus (all groups reached their consensus), the activity is automatically rejected.If not specified, the activity will never be rejected automatically (the approval process doesn’t “expire” / “times out”). |
initiatorCanApprove: true.Example 1: For any wallet transfer, a policy is setup to require approval from 1 specific admin user (eg. the CEO). initiatorCanApprove was not set to true. If the CEO himself initiates a transfer, no-one can approve his transfer and it’s stuck.Example 2: Company has only 3 users. A policy is setup to require approval from any 3 users (quorum: 3) for any modification of a policy. initiatorCanApprove was not set to true. In this case, they are locked, and the policy cannot be modified: whoever requests a modification cannot approve, and the policy is therefore always missing one approver. To unlock, they would need to invite a new user and give him the rights to approve as well.NoAction policy actionChainalysisTransactionPrescreening, ChainalysisTransactionScreening, or GlobalLedgerTransactionPrescreening. This action is for when you just want the KYT analysis rule to be run, and then if triggered, those results returned in a policy.triggered Webhook Event.
{
"action": {
"kind": "NoAction"
}
}
activityKind).
For example, you can use filters to setup a policy for activities happening on specific wallets or on groups of wallets. Some examples include:
group:treasury’ must first be approved by the CEOaccounting:freeze’ must be blocked”activityKind of your policy (activityKind)
"Wallets:Sign" activity| key | evaluator | Value |
|---|---|---|
| walletId | in | List of wallet IDs. If the activity is from a wallet within one of these IDs, the policy applies to this wallet. |
| walletTags | hasAny | List of tags. If the activity is from a wallet that has any of these tags, the policy will apply to this wallet. |
| walletTags | hasAll | List of tags. If the activity is from a wallet that has all of these tags, the policy will apply to this wallet. |
wa-1 or wa-2:{
"filters": {
"walletId": {
"in": ["wa-1", "wa-2"]
}
}
}
domain:accounting” or “sensitive”:{
"filters": {
"walletTags": {
"hasAny": ["domain:accounting", "sensitive"]
}
}
}
domain:accounting” and “sensitive”: {
"filters": {
"walletTags": {
"hasAll": ["domain:accounting", "sensitive"]
}
}
}
domain:accounting”, “zone:asia”) AND at least one of these tags (“security:high”, “security:medium”): {
"filters": {
"walletTags": {
"hasAll": ["domain:accounting", "zone:asia"],
"hasAny": ["security:high", "security:medium"]
}
}
}
"Policies:Modify" activity| filter key | evaluator | Value |
|---|---|---|
policyId | in | List of policy IDs. If the policy being modified is one of these IDs, the policy applies. |
plc-1 or plc-2{
"filters": {
"policyId": {
"in": ["plc-1", "plc-2"]
}
}
}
"Permissions:Modify" activity| filter key | evaluator | Value |
|---|---|---|
| permissionId | in | List of permission IDs. If the permission being modified is one of these IDs, the policy applies. |
pm-1 or pm-2{
"filters": {
"permissionId": {
"in": ["pm-1", "pm-2"]
}
}
}
"Permissions:Assign" activity| filter key | evaluator | Value |
|---|---|---|
| permissionId | in | List of permission IDs. If the permission being assigned/revoked is one of these IDs, the policy applies. |
pm-1 or pm-2{
"filters": {
"permissionId": {
"in": ["pm-1", "pm-2"]
}
}
}
Active, Archived Registry:Addresses:Modify This rule will always be triggered, meaning that if this rule is defined on a policy, the policy will always trigger the policy action, regardless of the activity details.
Show child attributes
This action means that activity will first require an Approval process to be completed before it can be executed (or be aborted if someone rejects it during the approval process).
One or several groups of approvers need to be specified. These groups define who is allowed to approve / reject an activity.
The activity will only be executed if all approver groups reach their "quorum" of approvals. Otherwise, if any one user within any approver group rejects, then the activity is aborted and the call is not executed.
The example below shows a RequestApproval action, configured with one approval group requiring 2 approvals amongst three specific users.
{
"action": {
"kind": "RequestApproval",
"autoRejectTimeout": 60, // minutes
"approvalGroups": [
{
"name": "Admins",
"quorum": 2, // only 2 approvers required in that group
"approvers": {
"userId": {
"in": ["us-...1", "us-...2", "us-...3"],
}
}
}
],
}
}Don't lock yourself up
By default, users cannot approve an activity they initiated themselves, even if they are in an approval group. To allow this, you must set initiatorCanApprove: true.
Example 1: For any wallet transfer, a policy is setup to require approval from 1 specific admin user (eg. the CEO). initiatorCanApprove was not set to true. If the CEO himself initiates a transfer, no-one can approve his transfer and it's stuck.
Example 2: Company has only 3 users. A policy is setup to require approval from any 3 users (quorum: 3) for any modification of a policy. initiatorCanApprove was not set to true. In this case, they are locked, and the policy cannot be modified: whoever requests a modification cannot approve, and the policy is therefore always missing one approver. To unlock, they would need to invite a new user and give him the rights to approve as well.
Show child attributes
Was this page helpful?