v2.0
GitHub

Start detecting financial crime
in minutes.

The CaseForge SDK wraps the CaseForge REST API into idiomatic Python and Node.js libraries. Create cases, screen transactions, file SARs, and manage watchlists — without writing raw HTTP calls.

Get started → View code samples

What you can do with the SDK

The CaseForge SDK covers the full AML case management lifecycle. You can automate high-volume transaction screening, integrate SAR filing into existing compliance workflows, and build real-time alerting on top of the CaseForge rules engine — all from your own application code.

⚡
Quickstart
Install the SDK, configure your API key, and create your first case — in under 10 minutes.
🔑
Authentication
API keys for development. OAuth 2.0 client credentials for production server-to-server flows.
🛡️
Error handling
HTTP status mapping, SDK exception hierarchy, retry logic, and idempotency keys.
📋
Code samples
Python, Node.js, and cURL examples for every major operation: cases, SARs, watchlists.
📝
Changelog
Release history, breaking changes, deprecations, and version migration notes.
🔄
Migration guide
Step-by-step instructions for upgrading from SDK v1.x to v2.0, with side-by-side diffs.

Supported languages

LanguagePackageMin versionStatus
Pythoncaseforge-sdkPython 3.9+Stable
Node.js@caseforge/sdkNode.js 18+Stable
Javacom.caseforge:sdkJava 11+ (JDK)Beta
cURL—AnyREST reference

Installation

Install the SDK for your language using your standard package manager. No additional system dependencies are required.

pip install caseforge-sdk
npm install @caseforge/sdk
<dependency>
  <groupId>com.caseforge</groupId>
  <artifactId>sdk</artifactId>
  <version>2.0.0</version>
</dependency>

Your first API call

The following example authenticates with an API key and creates a new AML case. See the Quickstart for a fully annotated walkthrough.

Python
import caseforge

client = caseforge.Client(api_key="cf_live_...")

case = client.cases.create(
    subject_id="cust_7a2b4c",
    case_type="transaction_monitoring",
    priority="high",
    summary="Structuring pattern detected — 12 transactions below $10k threshold",
)

print(case.id)       # case_9x4m1z
print(case.status)   # open
Node.js
import CaseForge from '@caseforge/sdk';

const client = new CaseForge({ apiKey: 'cf_live_...' });

const aCase = await client.cases.create({
  subjectId:  'cust_7a2b4c',
  caseType:   'transaction_monitoring',
  priority:   'high',
  summary:    'Structuring pattern detected — 12 transactions below $10k threshold',
});

console.log(aCase.id);      // case_9x4m1z
console.log(aCase.status);  // open
cURL
curl -X POST https://api.caseforge.io/v2/cases \
  -H "Authorization: Bearer cf_live_..." \
  -H "Content-Type: application/json" \
  -d '{
    "subject_id": "cust_7a2b4c",
    "case_type": "transaction_monitoring",
    "priority": "high",
    "summary": "Structuring pattern detected — 12 transactions below $10k threshold"
  }'

Core concepts

ConceptDescription
CasesThe primary unit of investigation. A case links a subject, a set of transactions or events, attached evidence, and a resolution outcome.
SubjectsThe entity under investigation — a customer, business, or account. A subject can be linked to multiple cases across product lines.
SARsSuspicious Activity Reports. The SDK provides structured SAR creation that maps fields directly to FinCEN Form 111 requirements.
AlertsSystem-generated signals from the CaseForge rules engine. An alert can spawn a case automatically or queue for analyst review.
WatchlistsCurated lists of entities with elevated risk classifications. You can screen new subjects and transactions against watchlists in real time.
API versioning

This SDK targets the CaseForge REST API v2. The base URL for all requests is https://api.caseforge.io/v2/. The v1 API is deprecated and will reach end-of-life on December 31, 2026. See the migration guide to upgrade.