Define & Attach a Compliance Policy

This guide walks you through defining a compliance policy for an asset — setting regulation parameters, reading the policy back, and triggering a compliance check.

Prerequisites

• An organization set up (Onboard an Organization)
• An asset created (see step 2 of Deploy a Gated Asset, or create one via the dashboard)
• An API key with assets:write and assets:read scopes

1. Install and authenticate

1
import { SignumClient } from "@signum-tech/sdk";
2
3
const signum = new SignumClient({
4
  apiKey: process.env.SIGNUM_API_KEY,
5
});

2. Set the compliance policy

Attach a compliance policy to your asset. This example configures a Regulation D policy with accredited investor requirements:

1
const policy = await signum.orgs.assets.compliancePolicy.set(
2
  orgId,
3
  assetId,
4
  {
5
    regulation_type: "reg_d",
6
    min_kyc_level: 2,
7
    accredited_investor_required: true,
8
    blocked_countries: ["IRN", "PRK", "CUB"],
9
    max_holders: 2000,
10
    lockup_period_days: 365,
11
    transfer_restricted: false,
12
    chain_eid: 30101,
13
  }
14
);
15
16
console.log(policy); // The saved policy

When chain_eid is provided, the API returns 202 Accepted — the policy is saved and queued for on-chain registration. Without chain_eid, it returns 200 with the saved policy. Either way, the response includes policyId and assetId for tracking.

Policy fields

3. Read the policy back

Retrieve the current compliance policy for an asset:

1
const current = await signum.orgs.assets.compliancePolicy.get(orgId, assetId);
2
3
console.log(current.regulationType);          // "reg_d"
4
console.log(current.requiresAccreditation);   // true
5
console.log(current.blockedCountries);        // ["IRN", "PRK", "CUB"]

4. Trigger a compliance check

Queue an async compliance check against a wallet to verify it meets the policy requirements:

1
const check = await signum.compliance.check({
2
  wallet: "0xabc...def",
3
  chainEid: 30101,
4
  assetId: assetId,
5
});
6
7
console.log(check.accepted);  // true
8
console.log(check.checkId);   // "chk_abc123"
9
console.log(check.message);   // Guidance on result delivery

The API returns 202 Accepted. The check runs asynchronously — use webhooks or poll for the result.

5. Listen for compliance events

Four compliance event channels notify you of policy and check lifecycle changes:

See Subscribe to Webhooks for how to receive these events, or browse the full payload schemas in the API Reference.

Reference

• API Reference — operations and webhook payload schemas
• Compliance — API — REST operations for compliance
• Policies & Enforcement — deep-dive into the compliance model

Next steps

• Deploy a Gated Asset — create, deploy, and distribute a token
• Async Operations — polling and webhook correlation patterns