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

package/README.md

@@ -1,6 +1,6 @@
 # @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.
+Server-side Node.js SDK for [KwikID](https://identity.kwiknkap.com) identity verification. Create verification sessions, retrieve results, and verify webhook signatures.
 
 ## Installation
 
@@ -44,8 +44,8 @@ console.log(result.extractedData); // { firstName, lastName, dateOfBirth, ... }
 
 ```ts
 const kwikId = new KwikIDNode({
-  apiKey: "your-api-key", // Required — from KwikID dashboard
-  baseUrl: "https://api.kwik-id.com", // Optional — defaults to production
+  apiKey: "your-api-key", // Required — from KwikID dashboard at identity.kwiknkap.com
+  baseUrl: "https://api.identity.kwiknkap.com", // Optional — defaults to production
   timeout: 30000, // Optional — request timeout in ms (default: 30s)
 });
 ```
@@ -130,19 +130,18 @@ Gets the detailed result including scores and extracted document data.
 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
+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?.dateOfBirth;  // YYYY-MM-DD
+result.extractedData?.idNumber;     // Document number
+result.extractedData?.expiryDate;   // YYYY-MM-DD
 result.extractedData?.documentType;
-result.extractedData?.country;
 ```
 
 ### Webhooks
@@ -202,30 +201,41 @@ app.post("/webhooks/kwikid", (req, res) => {
 
 ```ts
 {
-  event: "verification.completed",
+  event: "verification.completed",   // WebhookEventType
   timestamp: "2024-01-15T10:30:00.000Z",
   data: {
     jobId: "job_abc123",
-    referenceId: "user_123",
+    referenceId: "user_123",          // your reference ID (if provided at session creation)
     status: "verified",
-    environment: "live", // "live" | "test"
-    scores: {
-      documentScore: 0.95,
-      faceMatchScore: 0.92,
-      livenessScore: 0.98,
+    environment: "live",              // "live" | "test"
+
+    // Scores — present on completed/rejected events
+    scores?: {
+      documentScore?: number;         // 0–1
+      documentBackScore?: number;     // 0–1 (if back was captured)
+      faceMatchScore?: number;        // 0–1
+      livenessScore?: number;         // 0–1
     },
-    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",
+
+    // Extracted OCR data — present on completed events
+    extractedData?: {
+      firstName?: string;
+      lastName?: string;
+      fullName?: string;
+      dateOfBirth?: string;           // YYYY-MM-DD
+      documentNumber?: string;
+      uniqueIdentifier?: string;
+      nationality?: string;
+      expiryDate?: string;            // YYYY-MM-DD
+      issuanceDate?: string;          // YYYY-MM-DD
+      documentType?: string;
     },
-    metadata: { plan: "premium" },
+
+    // Error info — present on failed events
+    errorCode?: string;
+    errorMessage?: string;
+
+    metadata?: Record<string, unknown>;
   }
 }
 ```

package/dist/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@kwik-id/sdk-node",
-    "version": "0.1.0-alpha.3",
+    "version": "0.1.0-alpha.4",
     "type": "module",
     "engines": {
         "node": ">=18"

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@kwik-id/sdk-node",
-  "version": "0.1.0-alpha.3",
+  "version": "0.1.0-alpha.4",
   "type": "module",
   "engines": {
     "node": ">=18"