Quickstart

This guide walks you through authenticating, reading data, and issuing your first attestation command — all in under five minutes.

Prerequisites

• A Clossir organization (sign up at app.dev.clossir.com)
• An API key with attestations:read and attestations:write scopes (see Authentication for how to create one)
• Node.js 18+ or Bun

1. Install the SDK

$
npm install @signum-tech/sdk

2. Authenticate

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

The API key is org-scoped — all operations are automatically isolated to your organization.

3. Make your first read

1
const parties = await signum.identity.parties.list();
2
3
console.log(`Found ${parties.data.length} parties in your org`);

Reads return 200 OK with the current state.

4. Issue your first attestation

1
const result = await signum.attestations.create({
2
  partyId: "pty_abc123",
3
  type: "accredited_investor",
4
  chainId: 1,
5
});
6
7
console.log(result.status); // 202 — accepted for processing
8
console.log(result.id);     // att_xyz789 — poll GET /attestations/:id for status

Commands return 202 Accepted — the attestation is queued for on-chain processing. Poll the GET /attestations/:id endpoint (or use webhooks) to know when it settles.

What just happened

1. Authenticated — your API key identified your org and authorized the scopes.
2. Read — fetched existing parties from Supabase (sync, GET → 200).
3. Commanded — issued an attestation request (POST → 202) that is processed asynchronously and settled on-chain; poll GET → 200 or subscribe to webhooks.

Next steps

• Concepts — understand the full data model
• Authentication — manage keys and scopes
• Identity — deep-dive into parties, wallets, and attestations