@aethoncredit/sdk

Official TypeScript SDK for the Aethon Credit Intelligence (ACI) API.

Installation

npm install @aethoncredit/sdk

Quick Start

import { ACIClient } from '@aethoncredit/sdk';

const aci = new ACIClient({ apiKey: 'sk_live_your_key_here' });

// List all provider scores
const scores = await aci.getScores();
scores.forEach(s => console.log(`${s.provider_name}: ${s.composite_score}`));

// Get a single provider's score
const score = await aci.getScore('provider-uuid');
console.log(score.risk_band); // 'LOW' | 'MEDIUM' | 'ELEVATED' | 'HIGH'

Sandbox

const sandbox = new ACIClient({
  apiKey: 'sk_test_your_key',
  baseUrl: 'https://sandbox.aethoncredit.com/v1',
});

Methods

| Method | Description | Tier | |--------|-------------|------| | getScores() | List all provider scores | FREE+ | | getScore(id) | Single provider detail | FREE+ | | getScoreHistory(id, opts?) | Score history & trends | PRO+ | | getMethodology() | Current ACI Framework methodology | FREE+ | | getComputationPackage(id) | Computation package | INST | | getStatus() | API health check | ALL |

Score History

const history = await aci.getScoreHistory('provider-uuid', {
  granularity: 'weekly',
  from: '2026-01-01',
  include_trend: true,
});

Error Handling

import { ACIClient, ACIApiError } from '@aethoncredit/sdk';

try {
  const score = await aci.getScore('invalid-id');
} catch (err) {
  if (err instanceof ACIApiError) {
    console.log(err.code);       // 'NOT_FOUND'
    console.log(err.statusCode); // 404
  }
}

Webhook Verification

import { WebhookVerifier } from '@aethoncredit/sdk';

const isValid = WebhookVerifier.verify(
  rawBody,
  request.headers['x-aci-signature'],
  'whsec_your_secret',
);

Built-in Features

• Automatic retry with exponential backoff (1s, 2s, 4s)
• Rate limit handling (429 waits for Retry-After)
• Configurable timeout (default 30s)
• Zero external dependencies