Node.js SDK Configuration & Authentication Setup - Corsa Documentation

Import CorsaClient and configure it with your API details:

import { CorsaClient } from '@corsa-labs/sdk';

const client = new CorsaClient({
    BASE: "https://api.corsa.finance",
    HEADERS: {
        "Authorization": `Bearer ${process.env.API_TOKEN}:${process.env.API_SECRET}`
    }
});

Alternatively, configure the global OpenAPI object:

import { CorsaClient, OpenAPI } from '@corsa-labs/sdk';

OpenAPI.BASE = 'https://api.corsa.finance';
OpenAPI.HEADERS = {
  "Authorization": `Bearer ${process.env.API_TOKEN}:${process.env.API_SECRET}`
};

const client = new CorsaClient();

Configuration Options

Option	Type	Default	Description
`BASE`	`string`	`''`	Base URL for the API.
`VERSION`	`string`	`'1.0'`	API version.
`HEADERS`	`Record<string, string>`	`undefined`	Custom request headers. Recommended for authentication.
`TOKEN`	`string`	`undefined`	Bearer token (deprecated; prefer `HEADERS`).
`USERNAME`	`string`	`undefined`	Basic auth username.
`PASSWORD`	`string`	`undefined`	Basic auth password.
`WITH_CREDENTIALS`	`boolean`	`false`	Include credentials in requests.
`CREDENTIALS`	`'include' \| 'omit' \| 'same-origin'`	`'include'`	Credentials mode for fetch.
`ENCODE_PATH`	`(path: string) => string`	`undefined`	Custom path encoder.

ComplianceClient is a deprecated alias for CorsaClient. Use CorsaClient in new code.

Encrypted Client

For HYOK workspaces, EncryptedCorsaClient encrypts protected fields on your side with your pinned HYOK public key:

import { EncryptedCorsaClient } from '@corsa-labs/sdk';

const client = EncryptedCorsaClient.withEncryptedFields(
  {
    baseUrl: "https://api.corsa.finance",
    apiKey: `${process.env.CORSA_API_TOKEN}:${process.env.CORSA_API_SECRET}`,
    publicKey: {
      spkiBase64: process.env.CORSA_HYOK_PUBLIC_KEY_SPKI,
      keyId: process.env.CORSA_HYOK_KEY_ID,
    },
    expectedKeySpkiSha256: process.env.CORSA_HYOK_KEY_SHA256,
  },
  encryptedFieldSchema
);

apiKey authenticates requests to Corsa. Encryption needs only your public key, so no encryption service credential is required. See Encrypt HYOK fields with the SDK for how to obtain and pin the key. With BYOK or Corsa-managed encryption, use the regular CorsaClient: Corsa encrypts on its side.