Skip to main content

Getting Started

Welcome to the Heuristik Developer Documentation. This guide will help you integrate identity verification into your application.

Choose your integration​

MethodBest forEffort
IframeQuick integration, hosted UILow
JavaScript SDKFull control, custom UIMedium
REST APIServer-to-server, any languageHigh

Quick overview​

Prerequisites​

Before you begin

You need a Heuristik account and an API key. Sign up at dashboard.heuristik.com.

  • A Heuristik API key (live or sandbox)
  • Node.js 20+ (for the JavaScript SDK)
  • HTTPS enabled on your domain

Installation​

npm install @heuristik/sdk

First verification​

app.ts
import { HeuristikClient } from '@heuristik/sdk';

const client = new HeuristikClient({
apiKey: 'sk_sandbox_your_key_here',
});

const session = await client.createSession({
referenceId: 'user-12345',
redirectUrl: 'https://yourapp.com/callback',
});

console.log('Session token:', session.token);
What's next?

Head to the Iframe integration for the quickest setup, or dive into the JavaScript SDK for full control.

Sandbox vs Production

Always use sandbox keys (sk_sandbox_*) during development. Production keys (sk_live_*) process real verifications.

Rate limits

The API enforces rate limits of 100 requests per minute per API key. See Error Handling for details.