Skip to main content

Install the SDK

You can install the @corsa-labs/sdk package using npm or yarn:

Requirements

  • Node.js 18 or later
  • TypeScript 4.7+ (recommended, but not required)
  • A Corsa API key - see Authentication to create one

Quick Start

Once installed, initialize the client and make your first API call:

What’s Included

The SDK is a fully typed wrapper around the Corsa REST API. It provides:
  • Type-safe methods for all API endpoints - clients, transactions, alerts, cases, rules, and more
  • TypeScript definitions for all request and response objects
  • HYOK support via EncryptedCorsaClient for platforms with field-level encryption

Next Steps

Configuration

Configure the SDK with your API credentials and explore all available options.

Available Services

Browse all services and methods exposed by the SDK.

Working Example

See a full working example that ingests clients, transactions, and alerts.

Authentication

Create API keys and learn about authentication, rate limiting, and base URLs.

Need help with your integration? Schedule a demo or contact us at support@corsa.finance.