Skip to main content

Ruleset Assignment

If you have a default ruleset, all your customers and their accounts are automatically assigned to that ruleset. You can also assign rulesets to specific accounts by using our Ruleset Assignment APIs.

This lets you:

  • apply a ruleset to all tokens under an account (account scope), or
  • apply a ruleset only to selected token types or token IDs (token scope).

Assign ruleset to account​

Use Assign Ruleset to Account API to assign a ruleset to an account.

Account-level assignment​

Set the scope level to account to assign a ruleset to all tokens under an account.

{
  "ruleset_id": "8e7464c2-d1b1-4f4a-9705-53ed4b74bfb5",
  "scope": {
    "level": "account"
  }
}

Token-level assignment​

For level: token, pass either provision_types or provision_ids.

Provision types are:

  • customer_account_device for Own App tokens
  • static_token for Virtual Cards
  • digital_token for Digital Wallet Tokens

When specifying provision_ids, use:

  • device_id for Own App tokens
  • static_token_id for Virtual Cards
  • digital_token_id for Digital Wallet Tokens
{
  "ruleset_id": "8e7464c2-d1b1-4f4a-9705-53ed4b74bfb5",
  "scope": {
    "level": "token",
    "provision_types": ["static_token"]
  }
}

Assigning multiple rulesets​

When multiple rulesets are applied to an account, they are all evaluated during transactions. This also applies when one ruleset is assigned at the account level and another is assigned at the token level: both rulesets apply to that token.

The only exception is the default ruleset, which will only apply if no other ruleset has been applied to the account.

Other operations​