VerifyHQ Docs

SDKs & Libraries

The official client package in this repository is the TypeScript SDK.

TypeScript

Official
Installationbash
npm install @joonapay/verify-hq-sdk
Usagetypescript
import { VerifyHQClient } from '@joonapay/verify-hq-sdk';

const client = new VerifyHQClient(
  'https://api.verifyhq.wejoona.com',
  process.env.VERIFYHQ_API_KEY!,
);

const verification = await client.startIdentityVerification('user_123', 'BASIC');

const document = await client.submitDocument(
  'user_123',
  'PASSPORT',
  'NG',
  passportFrontBlob,
);

const session = await client.createLivenessSession('user_123');
const documents = await client.getUserDocumentVerifications('user_123', 1, 20);
const livenessChecks = await client.getUserLivenessChecks('user_123', 1, 20);
const identities = await client.getUserVerifications('user_123', 1, 20);

Response Types

The SDK exposes typed status unions for document, liveness, and identity responses. User-history helpers return the API pagination envelope: { data, total, page, limit }.

Typed statusestypescript
import type {
  DocumentVerificationStatus,
  LivenessStatus,
  IdentityVerificationStatus,
} from '@joonapay/verify-hq-sdk';

Package Scope

The SDK currently wraps identity, document, and liveness endpoints. Use direct API calls for AML, watchlist, device, IP, business, and webhook endpoints until those clients are added.

Other Languages
Python, Go, Java, PHP, Ruby, and other SDKs are not shipped from this repository yet. Do not publish package install commands until those packages exist.