v0.1.0-devnet

Documentation

Everything you need to integrate compliance into your protocol

API Key Required

Get your API key from the dashboard to start making queries. Get your API key →

Quick Start

1. Install the SDK

Terminalbash

npm install @complian-cc/sdk

2. Initialize the client

client.tsts

import { ComplianClient } from "@complian-cc/sdk";

const client = new ComplianClient({
  cluster: "devnet",
  apiKey: process.env.COMPLIAN_API_KEY,
});

3. Run a compliance check

check.tsts

const result = await client.sanctions.check(
  "7xKa...mP3d"
);

4. Handle the result

handler.tsts

if (result.status === "clear") {
  // Proceed with transaction
} else {
  // Block or flag for review
  console.log("Lists:", result.lists);
}

Module Reference

Sanctions

client.sanctions.check(walletAddress: string)

=> { status: 'clear' | 'flagged', lists: string[], confidence: number }

Sanctions examplets

const result = await client.sanctions.check(
  "7xKa...mP3d"
);
if (result.status === "flagged") {
  console.log("Match:", result.lists);
}

KYC Status

client.kyc.verify(walletAddress: string)

=> { tier: 0 | 1 | 2 | 3, provider: string, expiry: Date }

KYC Status examplets

const kyc = await client.kyc.verify(
  "Bv9R...xH2n"
);
if (kyc.tier >= 2) {
  // Allow high-value transactions
}

Travel Rule

client.travelRule.check(tx: TxPayload)

=> { required: boolean, threshold: number, jurisdiction: string }

Travel Rule examplets

const rule = await client.travelRule.check({
  from: "7xKa...mP3d",
  to: "Bv9R...xH2n",
  amount: 1200,
  currency: "USDC",
});

Jurisdiction

client.jurisdiction.rules(countryCode: string)

=> { framework: string, rules: Rule[], restrictions: string[] }

Jurisdiction examplets

const rules = await client.jurisdiction.rules("BR");
// { framework: "CVM 555",
//   rules: [...],
//   restrictions: ["leverage_limit"] }

Pricing

Tier	Price	Minimum	SLA	Support
Builder	$0.03/query	$50/mo	99.5%	Community
Scale	$0.01/query → $0.005 >2M/mo	$350/mo	99.5%	Priority
Enterprise	$0.005/query	$950/mo	99.9% + credits	Dedicated + named counsel

Architecture

DeFi ProtocolSDK call

CON GatewayRoute + cache

Oracle NodesConsensus (2/3)

Data SourcesOFAC / UN / EU

Query -> Gateway routes to nearest oracle cluster -> Nodes fetch from data sources -> 2/3 consensus -> Result cached on-chain -> Response <200ms