@kwik-id/sdk-node 0.1.0-alpha.3

package/README.md

@@ -0,0 +1,308 @@
+# @kwik-id/sdk-node
+
+Server-side Node.js SDK for [KwikID](https://kwik-id.com) identity verification. Create verification sessions, retrieve results, and verify webhook signatures.
+
+## Installation
+
+```bash
+npm install @kwik-id/sdk-node
+# or
+pnpm add @kwik-id/sdk-node
+# or
+yarn add @kwik-id/sdk-node
+```
+
+**Requirements:** Node.js 18+
+
+## Quick Start
+
+```ts
+import { KwikIDNode } from "@kwik-id/sdk-node";
+
+const kwikId = new KwikIDNode({
+  apiKey: process.env.KWIKID_API_KEY!,
+});
+
+// 1. Create a session (returns a clientSecret for the frontend SDK)
+const session = await kwikId.createSession({
+  referenceId: "user_123",
+  userName: "Jane Doe",
+  userEmail: "jane@example.com",
+});
+
+// 2. Pass session.token to your frontend as the clientSecret
+// The frontend SDK handles the verification flow
+
+// 3. Later, retrieve the verification result
+const result = await kwikId.getVerificationResult(session.jobId);
+console.log(result.status); // "verified" | "rejected" | "pending"
+console.log(result.scores); // { overall, liveness, document, faceMatch }
+console.log(result.extractedData); // { firstName, lastName, dateOfBirth, ... }
+```
+
+## Configuration
+
+```ts
+const kwikId = new KwikIDNode({
+  apiKey: "your-api-key", // Required — from KwikID dashboard
+  baseUrl: "https://api.kwik-id.com", // Optional — defaults to production
+  timeout: 30000, // Optional — request timeout in ms (default: 30s)
+});
+```
+
+## API Reference
+
+### Sessions
+
+#### `createSession(options?)`
+
+Creates a new verification session. Returns a `SessionToken` containing the `token` (client secret) to pass to the frontend SDK.
+
+```ts
+const session = await kwikId.createSession({
+  referenceId: "user_123", // Optional — your internal user/order ID
+  userName: "Jane Doe", // Optional — pre-fill user name
+  userEmail: "jane@example.com", // Optional — pre-fill user email
+  metadata: { plan: "premium" }, // Optional — arbitrary metadata
+});
+
+// session.sessionId — unique session identifier
+// session.jobId     — verification job ID
+// session.token     — client secret for frontend SDK
+// session.expiresAt — ISO 8601 expiration timestamp
+```
+
+#### `getSession(sessionId)`
+
+Retrieves session details.
+
+```ts
+const details = await kwikId.getSession(session.sessionId);
+// details.isUsed    — whether the session has been consumed
+// details.expiresAt — expiration timestamp
+```
+
+### Verifications
+
+#### `listVerifications(options?)`
+
+Lists verification jobs with pagination and filtering.
+
+```ts
+const list = await kwikId.listVerifications({
+  status: "verified", // Filter by status
+  referenceId: "user_123", // Filter by your reference ID
+  page: 1, // Pagination
+  limit: 20,
+  sortBy: "createdAt", // "createdAt" | "updatedAt" | "status"
+  sortOrder: "desc", // "asc" | "desc"
+});
+
+// list.verifications — array of VerificationSummary
+// list.pagination    — { total, page, limit, totalPages }
+```
+
+#### `getVerification(id)`
+
+Gets full details of a single verification.
+
+```ts
+const verification = await kwikId.getVerification(jobId);
+// verification.status       — "pending" | "verified" | "rejected" | ...
+// verification.documentType — "passport" | "id_card" | "drivers_license" | ...
+// verification.userName
+// verification.completedAt
+```
+
+#### `getVerificationByReference(referenceId)`
+
+Looks up a verification by your reference ID.
+
+```ts
+const verification = await kwikId.getVerificationByReference("user_123");
+```
+
+#### `getVerificationResult(id)`
+
+Gets the detailed result including scores and extracted document data.
+
+```ts
+const result = await kwikId.getVerificationResult(jobId);
+
+// Scores (0–1 scale)
+result.scores?.overall;   // Combined score
+result.scores?.liveness;  // Liveness detection score
+result.scores?.document;  // Document authenticity score
+result.scores?.faceMatch; // Face match score
+
+// Extracted document data (from OCR)
+result.extractedData?.firstName;
+result.extractedData?.lastName;
+result.extractedData?.dateOfBirth;   // YYYY-MM-DD
+result.extractedData?.idNumber;      // Document number
+result.extractedData?.expiryDate;    // YYYY-MM-DD
+result.extractedData?.documentType;
+result.extractedData?.country;
+```
+
+### Webhooks
+
+#### `verifyWebhookSignature(options)`
+
+Verifies incoming webhook signatures to ensure authenticity. Webhooks are signed using HMAC-SHA256.
+
+```ts
+import { verifyWebhookSignature } from "@kwik-id/sdk-node";
+
+// Express example
+app.post("/webhooks/kwikid", (req, res) => {
+  const result = verifyWebhookSignature({
+    payload: JSON.stringify(req.body),
+    signature: req.headers["kwik-signature"] as string,
+    secret: process.env.KWIKID_WEBHOOK_SECRET!,
+    toleranceSeconds: 300, // Optional — reject events older than 5min (default)
+  });
+
+  if (!result.valid) {
+    console.error("Invalid webhook:", result.error);
+    return res.status(400).send("Invalid signature");
+  }
+
+  const { event } = result;
+
+  switch (event.event) {
+    case "verification.completed":
+      console.log("Verified:", event.data.jobId);
+      console.log("Scores:", event.data.scores);
+      console.log("Extracted:", event.data.extractedData);
+      break;
+    case "verification.rejected":
+      console.log("Rejected:", event.data.jobId);
+      break;
+    case "verification.failed":
+      console.log("Failed:", event.data.errorMessage);
+      break;
+  }
+
+  res.sendStatus(200);
+});
+```
+
+### Webhook Events
+
+| Event | Description |
+|---|---|
+| `verification.started` | User began the verification flow |
+| `verification.uploaded` | Documents and selfie uploaded |
+| `verification.completed` | Verification passed |
+| `verification.rejected` | Verification rejected (e.g., document mismatch) |
+| `verification.failed` | Verification failed (e.g., processing error) |
+
+### Webhook Payload
+
+```ts
+{
+  event: "verification.completed",
+  timestamp: "2024-01-15T10:30:00.000Z",
+  data: {
+    jobId: "job_abc123",
+    referenceId: "user_123",
+    status: "verified",
+    environment: "live", // "live" | "test"
+    scores: {
+      documentScore: 0.95,
+      faceMatchScore: 0.92,
+      livenessScore: 0.98,
+    },
+    extractedData: {
+      firstName: "Jane",
+      lastName: "Doe",
+      fullName: "Jane Doe",
+      dateOfBirth: "1990-01-15",
+      documentNumber: "AB1234567",
+      nationality: "Cameroon",
+      expiryDate: "2030-12-31",
+      issuanceDate: "2020-01-01",
+      documentType: "id_card",
+    },
+    metadata: { plan: "premium" },
+  }
+}
+```
+
+## Framework Examples
+
+### Express
+
+```ts
+import express from "express";
+import { KwikIDNode } from "@kwik-id/sdk-node";
+
+const app = express();
+const kwikId = new KwikIDNode({ apiKey: process.env.KWIKID_API_KEY! });
+
+// Create a session for the frontend
+app.post("/api/create-session", async (req, res) => {
+  const session = await kwikId.createSession({
+    referenceId: req.user.id,
+    userName: req.user.name,
+  });
+  res.json({ clientSecret: session.token });
+});
+```
+
+### Next.js (App Router)
+
+```ts
+// app/api/verification/session/route.ts
+import { KwikIDNode } from "@kwik-id/sdk-node";
+import { NextResponse } from "next/server";
+
+const kwikId = new KwikIDNode({ apiKey: process.env.KWIKID_API_KEY! });
+
+export async function POST(request: Request) {
+  const { userId, userName } = await request.json();
+  const session = await kwikId.createSession({
+    referenceId: userId,
+    userName,
+  });
+  return NextResponse.json({ clientSecret: session.token });
+}
+```
+
+### NestJS
+
+```ts
+import { Injectable } from "@nestjs/common";
+import { KwikIDNode } from "@kwik-id/sdk-node";
+
+@Injectable()
+export class VerificationService {
+  private kwikId = new KwikIDNode({ apiKey: process.env.KWIKID_API_KEY! });
+
+  async createSession(userId: string, userName: string) {
+    return this.kwikId.createSession({ referenceId: userId, userName });
+  }
+
+  async getResult(jobId: string) {
+    return this.kwikId.getVerificationResult(jobId);
+  }
+}
+```
+
+## Error Handling
+
+All methods throw an `Error` with a descriptive message on failure:
+
+```ts
+try {
+  const result = await kwikId.getVerification("invalid-id");
+} catch (error) {
+  // "KwikIDNode: GET /api/v1/verifications/invalid-id failed — Not found"
+  console.error(error.message);
+}
+```
+
+## License
+
+MIT

package/dist/index.cjs.js

@@ -0,0 +1 @@
+"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const m=require("crypto"),w="https://api.kwik-id.com",y=3e4;class g{apiKey;baseUrl;timeout;constructor(e){if(!e.apiKey)throw new Error("KwikIDNode: apiKey is required");this.apiKey=e.apiKey,this.baseUrl=(e.baseUrl??w).replace(/\/$/,""),this.timeout=e.timeout??y}async createSession(e={}){return this.request("POST","/api/v1/sessions",e)}async getSession(e){const r=await this.request("GET",`/api/v1/sessions/${e}`);if(r.error)throw new Error(`KwikIDNode: getSession failed — ${r.error.message??r.error.code}`);return r}async listVerifications(e={}){const r=new URLSearchParams;e.status&&r.set("status",e.status),e.referenceId&&r.set("referenceId",e.referenceId),e.page!=null&&r.set("page",String(e.page)),e.limit!=null&&r.set("limit",String(e.limit)),e.sortBy&&r.set("sortBy",e.sortBy),e.sortOrder&&r.set("sortOrder",e.sortOrder);const s=r.toString();return this.request("GET",`/api/v1/verifications${s?`?${s}`:""}`)}async getVerification(e){const r=await this.request("GET",`/api/v1/verifications/${e}`);if(r.error)throw new Error(`KwikIDNode: getVerification failed — ${r.error.message}`);return r}async getVerificationByReference(e){const r=await this.request("GET",`/api/v1/verifications/reference/${encodeURIComponent(e)}`);if(r.error)throw new Error(`KwikIDNode: getVerificationByReference failed — ${r.error.message}`);return r}async getVerificationResult(e){const r=await this.request("GET",`/api/v1/verifications/${e}/result`);if(r.error)throw new Error(`KwikIDNode: getVerificationResult failed — ${r.error.message}`);return r}async request(e,r,s){const c=`${this.baseUrl}${r}`,a=new AbortController,n=setTimeout(()=>a.abort(),this.timeout);let i;try{i=await fetch(c,{method:e,headers:{"Content-Type":"application/json","X-API-Key":this.apiKey},body:s!==void 0?JSON.stringify(s):void 0,signal:a.signal})}catch(t){throw t.name==="AbortError"?new Error(`KwikIDNode: request timed out after ${this.timeout}ms`):t}finally{clearTimeout(n)}if(!i.ok){let t=`HTTP ${i.status}`;try{const f=await i.json();t=f.message??f.error??t}catch{}throw new Error(`KwikIDNode: ${e} ${r} failed — ${t}`)}return i.json()}}function p(u){const{payload:e,signature:r,secret:s,toleranceSeconds:c=300}=u,a={};for(const o of r.split(",")){const l=o.indexOf("=");l!==-1&&(a[o.slice(0,l)]=o.slice(l+1))}const n=a.t,i=a.v1;if(!n||!i)return{valid:!1,error:"Invalid signature format"};const t=parseInt(n,10);if(isNaN(t))return{valid:!1,error:"Invalid timestamp in signature"};if(c>0){const o=Math.floor(Date.now()/1e3);if(Math.abs(o-t)>c)return{valid:!1,error:"Timestamp too old"}}const f=`${n}.${e}`,h=m.createHmac("sha256",s).update(f).digest("hex");let d;try{d=m.timingSafeEqual(Buffer.from(h,"hex"),Buffer.from(i,"hex"))}catch{return{valid:!1,error:"Signature comparison failed"}}if(!d)return{valid:!1,error:"Signature mismatch"};try{return{valid:!0,event:JSON.parse(e)}}catch{return{valid:!1,error:"Failed to parse payload as JSON"}}}exports.KwikIDNode=g;exports.verifyWebhookSignature=p;

package/dist/index.d.ts

@@ -0,0 +1,4 @@
+export { KwikIDNode } from './lib/kwik-node-sdk.js';
+export { verifyWebhookSignature } from './lib/webhook-verifier.js';
+export type { KwikIDNodeConfig, CreateSessionOptions, SessionToken, SessionDetails, Verification, VerificationSummary, VerificationResult, VerificationScores, ListVerificationsOptions, VerificationList, VerifyWebhookOptions, VerifyWebhookResult, WebhookEvent, WebhookEventType, } from './types/index.js';
+//# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,wBAAwB,CAAC;AACpD,OAAO,EAAE,sBAAsB,EAAE,MAAM,2BAA2B,CAAC;AACnE,YAAY,EACV,gBAAgB,EAChB,oBAAoB,EACpB,YAAY,EACZ,cAAc,EACd,YAAY,EACZ,mBAAmB,EACnB,kBAAkB,EAClB,kBAAkB,EAClB,wBAAwB,EACxB,gBAAgB,EAChB,oBAAoB,EACpB,mBAAmB,EACnB,YAAY,EACZ,gBAAgB,GACjB,MAAM,kBAAkB,CAAC"}

package/dist/index.es.js

@@ -0,0 +1,125 @@
+import { createHmac as h, timingSafeEqual as w } from "crypto";
+const g = "https://api.kwik-id.com", y = 3e4;
+class v {
+  apiKey;
+  baseUrl;
+  timeout;
+  constructor(e) {
+    if (!e.apiKey)
+      throw new Error("KwikIDNode: apiKey is required");
+    this.apiKey = e.apiKey, this.baseUrl = (e.baseUrl ?? g).replace(/\/$/, ""), this.timeout = e.timeout ?? y;
+  }
+  // ─── Sessions ────────────────────────────────────────────────────────────
+  async createSession(e = {}) {
+    return this.request("POST", "/api/v1/sessions", e);
+  }
+  async getSession(e) {
+    const r = await this.request(
+      "GET",
+      `/api/v1/sessions/${e}`
+    );
+    if (r.error)
+      throw new Error(`KwikIDNode: getSession failed — ${r.error.message ?? r.error.code}`);
+    return r;
+  }
+  // ─── Verifications ───────────────────────────────────────────────────────
+  async listVerifications(e = {}) {
+    const r = new URLSearchParams();
+    e.status && r.set("status", e.status), e.referenceId && r.set("referenceId", e.referenceId), e.page != null && r.set("page", String(e.page)), e.limit != null && r.set("limit", String(e.limit)), e.sortBy && r.set("sortBy", e.sortBy), e.sortOrder && r.set("sortOrder", e.sortOrder);
+    const s = r.toString();
+    return this.request("GET", `/api/v1/verifications${s ? `?${s}` : ""}`);
+  }
+  async getVerification(e) {
+    const r = await this.request(
+      "GET",
+      `/api/v1/verifications/${e}`
+    );
+    if (r.error)
+      throw new Error(`KwikIDNode: getVerification failed — ${r.error.message}`);
+    return r;
+  }
+  async getVerificationByReference(e) {
+    const r = await this.request(
+      "GET",
+      `/api/v1/verifications/reference/${encodeURIComponent(e)}`
+    );
+    if (r.error)
+      throw new Error(`KwikIDNode: getVerificationByReference failed — ${r.error.message}`);
+    return r;
+  }
+  async getVerificationResult(e) {
+    const r = await this.request(
+      "GET",
+      `/api/v1/verifications/${e}/result`
+    );
+    if (r.error)
+      throw new Error(`KwikIDNode: getVerificationResult failed — ${r.error.message}`);
+    return r;
+  }
+  // ─── Internal ────────────────────────────────────────────────────────────
+  async request(e, r, s) {
+    const c = `${this.baseUrl}${r}`, a = new AbortController(), n = setTimeout(() => a.abort(), this.timeout);
+    let i;
+    try {
+      i = await fetch(c, {
+        method: e,
+        headers: {
+          "Content-Type": "application/json",
+          "X-API-Key": this.apiKey
+        },
+        body: s !== void 0 ? JSON.stringify(s) : void 0,
+        signal: a.signal
+      });
+    } catch (t) {
+      throw t.name === "AbortError" ? new Error(`KwikIDNode: request timed out after ${this.timeout}ms`) : t;
+    } finally {
+      clearTimeout(n);
+    }
+    if (!i.ok) {
+      let t = `HTTP ${i.status}`;
+      try {
+        const f = await i.json();
+        t = f.message ?? f.error ?? t;
+      } catch {
+      }
+      throw new Error(`KwikIDNode: ${e} ${r} failed — ${t}`);
+    }
+    return i.json();
+  }
+}
+function $(u) {
+  const { payload: e, signature: r, secret: s, toleranceSeconds: c = 300 } = u, a = {};
+  for (const o of r.split(",")) {
+    const l = o.indexOf("=");
+    l !== -1 && (a[o.slice(0, l)] = o.slice(l + 1));
+  }
+  const n = a.t, i = a.v1;
+  if (!n || !i)
+    return { valid: !1, error: "Invalid signature format" };
+  const t = parseInt(n, 10);
+  if (isNaN(t))
+    return { valid: !1, error: "Invalid timestamp in signature" };
+  if (c > 0) {
+    const o = Math.floor(Date.now() / 1e3);
+    if (Math.abs(o - t) > c)
+      return { valid: !1, error: "Timestamp too old" };
+  }
+  const f = `${n}.${e}`, m = h("sha256", s).update(f).digest("hex");
+  let d;
+  try {
+    d = w(Buffer.from(m, "hex"), Buffer.from(i, "hex"));
+  } catch {
+    return { valid: !1, error: "Signature comparison failed" };
+  }
+  if (!d)
+    return { valid: !1, error: "Signature mismatch" };
+  try {
+    return { valid: !0, event: JSON.parse(e) };
+  } catch {
+    return { valid: !1, error: "Failed to parse payload as JSON" };
+  }
+}
+export {
+  v as KwikIDNode,
+  $ as verifyWebhookSignature
+};

package/dist/lib/kwik-node-sdk.d.ts

@@ -0,0 +1,15 @@
+import { KwikIDNodeConfig, CreateSessionOptions, SessionToken, SessionDetails, Verification, VerificationResult, ListVerificationsOptions, VerificationList } from '../types/index.js';
+export declare class KwikIDNode {
+    private readonly apiKey;
+    private readonly baseUrl;
+    private readonly timeout;
+    constructor(config: KwikIDNodeConfig);
+    createSession(options?: CreateSessionOptions): Promise<SessionToken>;
+    getSession(sessionId: string): Promise<SessionDetails>;
+    listVerifications(options?: ListVerificationsOptions): Promise<VerificationList>;
+    getVerification(id: string): Promise<Verification>;
+    getVerificationByReference(referenceId: string): Promise<Verification>;
+    getVerificationResult(id: string): Promise<VerificationResult>;
+    private request;
+}
+//# sourceMappingURL=kwik-node-sdk.d.ts.map

package/dist/lib/kwik-node-sdk.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"kwik-node-sdk.d.ts","sourceRoot":"","sources":["../../src/lib/kwik-node-sdk.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EACV,gBAAgB,EAChB,oBAAoB,EACpB,YAAY,EACZ,cAAc,EACd,YAAY,EACZ,kBAAkB,EAClB,wBAAwB,EACxB,gBAAgB,EACjB,MAAM,mBAAmB,CAAC;AAK3B,qBAAa,UAAU;IACrB,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAS;IAChC,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAS;IACjC,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAS;gBAErB,MAAM,EAAE,gBAAgB;IAW9B,aAAa,CAAC,OAAO,GAAE,oBAAyB,GAAG,OAAO,CAAC,YAAY,CAAC;IAIxE,UAAU,CAAC,SAAS,EAAE,MAAM,GAAG,OAAO,CAAC,cAAc,CAAC;IAatD,iBAAiB,CAAC,OAAO,GAAE,wBAA6B,GAAG,OAAO,CAAC,gBAAgB,CAAC;IAapF,eAAe,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,YAAY,CAAC;IAWlD,0BAA0B,CAAC,WAAW,EAAE,MAAM,GAAG,OAAO,CAAC,YAAY,CAAC;IAWtE,qBAAqB,CAAC,EAAE,EAAE,MAAM,GAAG,OAAO,CAAC,kBAAkB,CAAC;YAatD,OAAO;CAsCtB"}

package/dist/lib/webhook-verifier.d.ts

@@ -0,0 +1,3 @@
+import { VerifyWebhookOptions, VerifyWebhookResult } from '../types/index.js';
+export declare function verifyWebhookSignature(options: VerifyWebhookOptions): VerifyWebhookResult;
+//# sourceMappingURL=webhook-verifier.d.ts.map

package/dist/lib/webhook-verifier.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"webhook-verifier.d.ts","sourceRoot":"","sources":["../../src/lib/webhook-verifier.ts"],"names":[],"mappings":"AACA,OAAO,KAAK,EAAE,oBAAoB,EAAE,mBAAmB,EAAE,MAAM,mBAAmB,CAAC;AAEnF,wBAAgB,sBAAsB,CAAC,OAAO,EAAE,oBAAoB,GAAG,mBAAmB,CAmDzF"}

package/dist/package.json

@@ -0,0 +1,28 @@
+{
+    "name": "@kwik-id/sdk-node",
+    "version": "0.1.0-alpha.3",
+    "type": "module",
+    "engines": {
+        "node": ">=18"
+    },
+    "main": "./dist/index.cjs.js",
+    "module": "./dist/index.es.js",
+    "types": "./dist/index.d.ts",
+    "exports": {
+        "./package.json": "./package.json",
+        ".": {
+            "types": "./dist/index.d.ts",
+            "import": "./dist/index.es.js",
+            "require": "./dist/index.cjs.js",
+            "default": "./dist/index.es.js"
+        }
+    },
+    "files": [
+        "dist",
+        "!**/*.tsbuildinfo"
+    ],
+    "nx": {
+        "name": "sdk-node"
+    },
+    "dependencies": {}
+}

package/dist/types/index.d.ts

@@ -0,0 +1,135 @@
+export interface KwikIDNodeConfig {
+    apiKey: string;
+    baseUrl?: string;
+    timeout?: number;
+}
+export interface CreateSessionOptions {
+    referenceId?: string;
+    userName?: string;
+    userEmail?: string;
+    metadata?: Record<string, unknown>;
+}
+export interface SessionToken {
+    sessionId: string;
+    jobId: string;
+    token: string;
+    expiresAt: string;
+}
+export interface SessionDetails {
+    sessionId: string;
+    jobId: string;
+    isUsed: boolean;
+    expiresAt: string;
+}
+export interface VerificationSummary {
+    id: string;
+    referenceId?: string;
+    status: string;
+    documentType?: string;
+    userName?: string;
+    userEmail?: string;
+    createdAt: string;
+    completedAt?: string;
+}
+export interface Verification {
+    id: string;
+    referenceId?: string;
+    status: string;
+    documentType?: string;
+    userName?: string;
+    userEmail?: string;
+    country?: string;
+    createdAt: string;
+    startedAt?: string;
+    completedAt?: string;
+    duration?: number;
+}
+export interface VerificationScores {
+    overall: number;
+    liveness?: number;
+    document?: number;
+    faceMatch?: number;
+}
+export interface VerificationResult {
+    id: string;
+    referenceId?: string;
+    status: string;
+    scores?: VerificationScores;
+    extractedData?: {
+        documentType?: string;
+        country?: string;
+        firstName?: string;
+        lastName?: string;
+        dateOfBirth?: string;
+        idNumber?: string;
+        expiryDate?: string;
+    };
+    error?: {
+        code: string;
+        message: string;
+    };
+    completedAt?: string;
+}
+export interface ListVerificationsOptions {
+    status?: string;
+    referenceId?: string;
+    page?: number;
+    limit?: number;
+    sortBy?: "createdAt" | "updatedAt" | "status";
+    sortOrder?: "asc" | "desc";
+}
+export interface VerificationList {
+    verifications: VerificationSummary[];
+    pagination: {
+        total: number;
+        page: number;
+        limit: number;
+        totalPages: number;
+    };
+}
+export interface VerifyWebhookOptions {
+    payload: string;
+    signature: string;
+    secret: string;
+    toleranceSeconds?: number;
+}
+export type VerifyWebhookResult = {
+    valid: true;
+    event: WebhookEvent;
+} | {
+    valid: false;
+    error: string;
+};
+export type WebhookEventType = "verification.started" | "verification.uploaded" | "verification.completed" | "verification.rejected" | "verification.failed";
+export interface WebhookEvent {
+    event: WebhookEventType;
+    timestamp: string;
+    data: {
+        jobId: string;
+        referenceId?: string;
+        status: string;
+        environment: "live" | "test";
+        scores?: {
+            documentScore?: number;
+            documentBackScore?: number;
+            faceMatchScore?: number;
+            livenessScore?: number;
+        };
+        extractedData?: {
+            firstName?: string;
+            lastName?: string;
+            fullName?: string;
+            dateOfBirth?: string;
+            documentNumber?: string;
+            uniqueIdentifier?: string;
+            nationality?: string;
+            expiryDate?: string;
+            issuanceDate?: string;
+            documentType?: string;
+        };
+        errorCode?: string;
+        errorMessage?: string;
+        metadata?: Record<string, unknown>;
+    };
+}
+//# sourceMappingURL=index.d.ts.map

package/dist/types/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/types/index.ts"],"names":[],"mappings":"AAEA,MAAM,WAAW,gBAAgB;IAC7B,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,OAAO,CAAC,EAAE,MAAM,CAAC;CACpB;AAED,MAAM,WAAW,oBAAoB;IACjC,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;CACtC;AAED,MAAM,WAAW,YAAY;IACzB,SAAS,EAAE,MAAM,CAAC;IAClB,KAAK,EAAE,MAAM,CAAC;IACd,KAAK,EAAE,MAAM,CAAC;IACd,SAAS,EAAE,MAAM,CAAC;CACrB;AAID,MAAM,WAAW,cAAc;IAC3B,SAAS,EAAE,MAAM,CAAC;IAClB,KAAK,EAAE,MAAM,CAAC;IACd,MAAM,EAAE,OAAO,CAAC;IAChB,SAAS,EAAE,MAAM,CAAC;CACrB;AAID,MAAM,WAAW,mBAAmB;IAChC,EAAE,EAAE,MAAM,CAAC;IACX,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,MAAM,EAAE,MAAM,CAAC;IACf,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,SAAS,EAAE,MAAM,CAAC;IAClB,WAAW,CAAC,EAAE,MAAM,CAAC;CACxB;AAED,MAAM,WAAW,YAAY;IACzB,EAAE,EAAE,MAAM,CAAC;IACX,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,MAAM,EAAE,MAAM,CAAC;IACf,YAAY,CAAC,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,OAAO,CAAC,EAAE,MAAM,CAAC;IACjB,SAAS,EAAE,MAAM,CAAC;IAClB,SAAS,CAAC,EAAE,MAAM,CAAC;IACnB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,QAAQ,CAAC,EAAE,MAAM,CAAC;CACrB;AAED,MAAM,WAAW,kBAAkB;IAC/B,OAAO,EAAE,MAAM,CAAC;IAChB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,SAAS,CAAC,EAAE,MAAM,CAAC;CACtB;AAED,MAAM,WAAW,kBAAkB;IAC/B,EAAE,EAAE,MAAM,CAAC;IACX,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,MAAM,EAAE,MAAM,CAAC;IACf,MAAM,CAAC,EAAE,kBAAkB,CAAC;IAC5B,aAAa,CAAC,EAAE;QACZ,YAAY,CAAC,EAAE,MAAM,CAAC;QACtB,OAAO,CAAC,EAAE,MAAM,CAAC;QACjB,SAAS,CAAC,EAAE,MAAM,CAAC;QACnB,QAAQ,CAAC,EAAE,MAAM,CAAC;QAClB,WAAW,CAAC,EAAE,MAAM,CAAC;QACrB,QAAQ,CAAC,EAAE,MAAM,CAAC;QAClB,UAAU,CAAC,EAAE,MAAM,CAAC;KACvB,CAAC;IACF,KAAK,CAAC,EAAE;QACJ,IAAI,EAAE,MAAM,CAAC;QACb,OAAO,EAAE,MAAM,CAAC;KACnB,CAAC;IACF,WAAW,CAAC,EAAE,MAAM,CAAC;CACxB;AAED,MAAM,WAAW,wBAAwB;IACrC,MAAM,CAAC,EAAE,MAAM,CAAC;IAChB,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,IAAI,CAAC,EAAE,MAAM,CAAC;IACd,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,MAAM,CAAC,EAAE,WAAW,GAAG,WAAW,GAAG,QAAQ,CAAC;IAC9C,SAAS,CAAC,EAAE,KAAK,GAAG,MAAM,CAAC;CAC9B;AAED,MAAM,WAAW,gBAAgB;IAC7B,aAAa,EAAE,mBAAmB,EAAE,CAAC;IACrC,UAAU,EAAE;QACR,KAAK,EAAE,MAAM,CAAC;QACd,IAAI,EAAE,MAAM,CAAC;QACb,KAAK,EAAE,MAAM,CAAC;QACd,UAAU,EAAE,MAAM,CAAC;KACtB,CAAC;CACL;AAID,MAAM,WAAW,oBAAoB;IACjC,OAAO,EAAE,MAAM,CAAC;IAChB,SAAS,EAAE,MAAM,CAAC;IAClB,MAAM,EAAE,MAAM,CAAC;IACf,gBAAgB,CAAC,EAAE,MAAM,CAAC;CAC7B;AAED,MAAM,MAAM,mBAAmB,GACzB;IAAE,KAAK,EAAE,IAAI,CAAC;IAAC,KAAK,EAAE,YAAY,CAAA;CAAE,GACpC;IAAE,KAAK,EAAE,KAAK,CAAC;IAAC,KAAK,EAAE,MAAM,CAAA;CAAE,CAAC;AAEtC,MAAM,MAAM,gBAAgB,GACtB,sBAAsB,GACtB,uBAAuB,GACvB,wBAAwB,GACxB,uBAAuB,GACvB,qBAAqB,CAAC;AAE5B,MAAM,WAAW,YAAY;IACzB,KAAK,EAAE,gBAAgB,CAAC;IACxB,SAAS,EAAE,MAAM,CAAC;IAClB,IAAI,EAAE;QACF,KAAK,EAAE,MAAM,CAAC;QACd,WAAW,CAAC,EAAE,MAAM,CAAC;QACrB,MAAM,EAAE,MAAM,CAAC;QACf,WAAW,EAAE,MAAM,GAAG,MAAM,CAAC;QAC7B,MAAM,CAAC,EAAE;YACL,aAAa,CAAC,EAAE,MAAM,CAAC;YACvB,iBAAiB,CAAC,EAAE,MAAM,CAAC;YAC3B,cAAc,CAAC,EAAE,MAAM,CAAC;YACxB,aAAa,CAAC,EAAE,MAAM,CAAC;SAC1B,CAAC;QACF,aAAa,CAAC,EAAE;YACZ,SAAS,CAAC,EAAE,MAAM,CAAC;YACnB,QAAQ,CAAC,EAAE,MAAM,CAAC;YAClB,QAAQ,CAAC,EAAE,MAAM,CAAC;YAClB,WAAW,CAAC,EAAE,MAAM,CAAC;YACrB,cAAc,CAAC,EAAE,MAAM,CAAC;YACxB,gBAAgB,CAAC,EAAE,MAAM,CAAC;YAC1B,WAAW,CAAC,EAAE,MAAM,CAAC;YACrB,UAAU,CAAC,EAAE,MAAM,CAAC;YACpB,YAAY,CAAC,EAAE,MAAM,CAAC;YACtB,YAAY,CAAC,EAAE,MAAM,CAAC;SACzB,CAAC;QACF,SAAS,CAAC,EAAE,MAAM,CAAC;QACnB,YAAY,CAAC,EAAE,MAAM,CAAC;QACtB,QAAQ,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,OAAO,CAAC,CAAC;KACtC,CAAC;CACL"}

package/package.json

@@ -0,0 +1,28 @@
+{
+  "name": "@kwik-id/sdk-node",
+  "version": "0.1.0-alpha.3",
+  "type": "module",
+  "engines": {
+    "node": ">=18"
+  },
+  "main": "./dist/index.cjs.js",
+  "module": "./dist/index.es.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    "./package.json": "./package.json",
+    ".": {
+      "types": "./dist/index.d.ts",
+      "import": "./dist/index.es.js",
+      "require": "./dist/index.cjs.js",
+      "default": "./dist/index.es.js"
+    }
+  },
+  "files": [
+    "dist",
+    "!**/*.tsbuildinfo"
+  ],
+  "nx": {
+    "name": "sdk-node"
+  },
+  "dependencies": {}
+}