@proveanything/smartlinks 1.13.15 → 1.13.16

package/dist/api/authKit.d.ts

@@ -29,7 +29,7 @@ export declare namespace authKit {
     function verifyPhoneCode(clientId: string, phoneNumber: string, code: string): Promise<PhoneVerifyResponse>;
     /** Send a WhatsApp verification deep-link (public). */
     function sendWhatsApp(clientId: string, body?: SendWhatsAppRequest): Promise<SendWhatsAppResponse>;
-    /** Manually verify WhatsApp token if inbound webhook path is unavailable (public). */
+    /** Manually verify WhatsApp token if inbound webhook path is unavailable (legacy/public fallback). */
     function verifyWhatsApp(clientId: string, token: string, phoneNumber: string): Promise<VerifyWhatsAppResponse>;
     /** Poll WhatsApp verification status for a token (public). */
     function getWhatsAppStatus(clientId: string, token: string): Promise<WhatsAppStatusResponse>;

package/dist/api/authKit.js

@@ -51,7 +51,7 @@ export var authKit;
         return post(`/authkit/${encodeURIComponent(clientId)}/auth/whatsapp/send`, body);
     }
     authKit.sendWhatsApp = sendWhatsApp;
-    /** Manually verify WhatsApp token if inbound webhook path is unavailable (public). */
+    /** Manually verify WhatsApp token if inbound webhook path is unavailable (legacy/public fallback). */
     async function verifyWhatsApp(clientId, token, phoneNumber) {
         return post(`/authkit/${encodeURIComponent(clientId)}/auth/whatsapp/verify`, { token, phoneNumber });
     }

package/dist/docs/API_SUMMARY.md

@@ -1,6 +1,6 @@
 # Smartlinks API Summary
 
-Version: 1.13.15  |  Generated: 2026-05-15T14:02:11.202Z
+Version: 1.13.16  |  Generated: 2026-05-15T19:36:34.712Z
 
 This is a concise summary of all available API functions and types.
 
@@ -3043,12 +3043,27 @@ interface WhatsAppReplyOptions {
 }
 ```
 
+**WhatsAppContactData** (interface)
+```typescript
+interface WhatsAppContactData {
+  name?: string
+  firstName?: string
+  lastName?: string
+  displayName?: string
+  email?: string
+  source?: string
+  customFields?: Record<string, unknown>
+  externalIds?: Record<string, unknown>
+}
+```
+
 **SendWhatsAppRequest** (interface)
 ```typescript
 interface SendWhatsAppRequest {
   redirectUrl?: string
   prefillMessage?: string
   reply?: WhatsAppReplyOptions
+  contactData?: WhatsAppContactData
 }
 ```
 
@@ -8229,7 +8244,7 @@ Verify phone verification code (public).
 Send a WhatsApp verification deep-link (public).
 
 **verifyWhatsApp**(clientId: string, token: string, phoneNumber: string) → `Promise<VerifyWhatsAppResponse>`
-Manually verify WhatsApp token if inbound webhook path is unavailable (public).
+Manually verify WhatsApp token if inbound webhook path is unavailable (legacy/public fallback).
 
 **getWhatsAppStatus**(clientId: string, token: string) → `Promise<WhatsAppStatusResponse>`
 Poll WhatsApp verification status for a token (public).

package/dist/docs/auth-kit.md

@@ -82,6 +82,8 @@ const session = await authKit.verifyPhoneCode(clientId, '+61400000000', '123456'
 
 Use these flows when you want low-friction verification before or without full account sign-in.
 
+WhatsApp verification is token-first. The user does not type their phone number in your app for this flow; phone ownership is proven by the inbound WhatsApp sender number.
+
 ```ts
 import { authKit } from '@proveanything/smartlinks';
 
@@ -92,6 +94,12 @@ const wa = await authKit.sendWhatsApp(clientId);
 // const wa = await authKit.sendWhatsApp(clientId, {
 //   redirectUrl: 'https://app.example.com/checkout/continue',
 //   prefillMessage: 'Please let me bid in this auction. Code: {{token}}',
+//   contactData: {
+//     name: 'Jane Doe',
+//     email: 'jane@example.com',
+//     source: 'auction-checkout',
+//     customFields: { agreedToTerms: true },
+//   },
 //   reply: {
 //     cta: {
 //       body: "You're verified and ready to bid.",
@@ -112,7 +120,7 @@ if (status.status === 'verified' && wa.sessionKey) {
   // session.token can be used as the authenticated bearer token
 }
 
-// Optional fallback path if webhook confirmation is unavailable
+// Optional legacy fallback path if webhook confirmation is unavailable
 await authKit.verifyWhatsApp(clientId, wa.token, '+447911123456');
 
 // 2) Or send SMS click-to-verify link
@@ -126,6 +134,13 @@ await authKit.sendSmsVerify(clientId, {
 await authKit.verifySms(clientId, '<token>', '+447911123456');
 ```
 
+`contactData` is optional and is useful when you collect name/email before the customer switches to WhatsApp.
+
+- Auth Kit stores `contactData` on the verification token metadata first.
+- Contact details are written to durable contact storage only after WhatsApp verification succeeds.
+- If the user abandons before verification, no contact is created.
+- `contactData` must not include phone; the verified inbound WhatsApp sender number is always authoritative.
+
 ### Contact bootstrap / durable identity
 
 After verification, upsert contact identity and store `contactId` on downstream records (raffle ticket, bid, claim intent).
@@ -183,6 +198,8 @@ const session = await authKit.exchangeWhatsAppSession(clientId, wa.token, wa.ses
 `sessionKey` is returned by `sendWhatsApp` and is used to mitigate token replay from contexts that did not initiate the browser flow.
 
 > **Note:** `redirectUrl` is optional. WhatsApp tokens are short hex strings (16 chars) for better UX.
+>
+> **Legacy note:** `verifyWhatsApp` is for older phone-bound token flows. Prefer inbound WhatsApp token confirmation plus status polling for new implementations.
 
 ### Google OAuth
 

package/dist/openapi.yaml

@@ -8589,7 +8589,7 @@ paths:
     post:
       tags:
         - authKit
-      summary: Manually verify WhatsApp token if inbound webhook path is unavailable (public).
+      summary: Manually verify WhatsApp token if inbound webhook path is unavailable (legacy/public fallback).
       operationId: authKit_verifyWhatsApp
       security: []
       parameters:
@@ -17915,6 +17915,27 @@ components:
           $ref: "#/components/schemas/WhatsAppReplyCta"
         text:
           type: string
+    WhatsAppContactData:
+      type: object
+      properties:
+        name:
+          type: string
+        firstName:
+          type: string
+        lastName:
+          type: string
+        displayName:
+          type: string
+        email:
+          type: string
+        source:
+          type: string
+        customFields:
+          type: object
+          additionalProperties: true
+        externalIds:
+          type: object
+          additionalProperties: true
     SendWhatsAppRequest:
       type: object
       properties:
@@ -17924,6 +17945,8 @@ components:
           type: string
         reply:
           $ref: "#/components/schemas/WhatsAppReplyOptions"
+        contactData:
+          $ref: "#/components/schemas/WhatsAppContactData"
     SendWhatsAppResponse:
       type: object
       properties:

package/dist/types/authKit.d.ts

@@ -90,10 +90,21 @@ export interface WhatsAppReplyOptions {
     /** Option C: plain-text fallback */
     text?: string;
 }
+export interface WhatsAppContactData {
+    name?: string;
+    firstName?: string;
+    lastName?: string;
+    displayName?: string;
+    email?: string;
+    source?: string;
+    customFields?: Record<string, unknown>;
+    externalIds?: Record<string, unknown>;
+}
 export interface SendWhatsAppRequest {
     redirectUrl?: string;
     prefillMessage?: string;
     reply?: WhatsAppReplyOptions;
+    contactData?: WhatsAppContactData;
 }
 export interface SendWhatsAppResponse {
     waLink: string;

package/docs/API_SUMMARY.md

@@ -1,6 +1,6 @@
 # Smartlinks API Summary
 
-Version: 1.13.15  |  Generated: 2026-05-15T14:02:11.202Z
+Version: 1.13.16  |  Generated: 2026-05-15T19:36:34.712Z
 
 This is a concise summary of all available API functions and types.
 
@@ -3043,12 +3043,27 @@ interface WhatsAppReplyOptions {
 }
 ```
 
+**WhatsAppContactData** (interface)
+```typescript
+interface WhatsAppContactData {
+  name?: string
+  firstName?: string
+  lastName?: string
+  displayName?: string
+  email?: string
+  source?: string
+  customFields?: Record<string, unknown>
+  externalIds?: Record<string, unknown>
+}
+```
+
 **SendWhatsAppRequest** (interface)
 ```typescript
 interface SendWhatsAppRequest {
   redirectUrl?: string
   prefillMessage?: string
   reply?: WhatsAppReplyOptions
+  contactData?: WhatsAppContactData
 }
 ```
 
@@ -8229,7 +8244,7 @@ Verify phone verification code (public).
 Send a WhatsApp verification deep-link (public).
 
 **verifyWhatsApp**(clientId: string, token: string, phoneNumber: string) → `Promise<VerifyWhatsAppResponse>`
-Manually verify WhatsApp token if inbound webhook path is unavailable (public).
+Manually verify WhatsApp token if inbound webhook path is unavailable (legacy/public fallback).
 
 **getWhatsAppStatus**(clientId: string, token: string) → `Promise<WhatsAppStatusResponse>`
 Poll WhatsApp verification status for a token (public).

package/docs/auth-kit.md

@@ -82,6 +82,8 @@ const session = await authKit.verifyPhoneCode(clientId, '+61400000000', '123456'
 
 Use these flows when you want low-friction verification before or without full account sign-in.
 
+WhatsApp verification is token-first. The user does not type their phone number in your app for this flow; phone ownership is proven by the inbound WhatsApp sender number.
+
 ```ts
 import { authKit } from '@proveanything/smartlinks';
 
@@ -92,6 +94,12 @@ const wa = await authKit.sendWhatsApp(clientId);
 // const wa = await authKit.sendWhatsApp(clientId, {
 //   redirectUrl: 'https://app.example.com/checkout/continue',
 //   prefillMessage: 'Please let me bid in this auction. Code: {{token}}',
+//   contactData: {
+//     name: 'Jane Doe',
+//     email: 'jane@example.com',
+//     source: 'auction-checkout',
+//     customFields: { agreedToTerms: true },
+//   },
 //   reply: {
 //     cta: {
 //       body: "You're verified and ready to bid.",
@@ -112,7 +120,7 @@ if (status.status === 'verified' && wa.sessionKey) {
   // session.token can be used as the authenticated bearer token
 }
 
-// Optional fallback path if webhook confirmation is unavailable
+// Optional legacy fallback path if webhook confirmation is unavailable
 await authKit.verifyWhatsApp(clientId, wa.token, '+447911123456');
 
 // 2) Or send SMS click-to-verify link
@@ -126,6 +134,13 @@ await authKit.sendSmsVerify(clientId, {
 await authKit.verifySms(clientId, '<token>', '+447911123456');
 ```
 
+`contactData` is optional and is useful when you collect name/email before the customer switches to WhatsApp.
+
+- Auth Kit stores `contactData` on the verification token metadata first.
+- Contact details are written to durable contact storage only after WhatsApp verification succeeds.
+- If the user abandons before verification, no contact is created.
+- `contactData` must not include phone; the verified inbound WhatsApp sender number is always authoritative.
+
 ### Contact bootstrap / durable identity
 
 After verification, upsert contact identity and store `contactId` on downstream records (raffle ticket, bid, claim intent).
@@ -183,6 +198,8 @@ const session = await authKit.exchangeWhatsAppSession(clientId, wa.token, wa.ses
 `sessionKey` is returned by `sendWhatsApp` and is used to mitigate token replay from contexts that did not initiate the browser flow.
 
 > **Note:** `redirectUrl` is optional. WhatsApp tokens are short hex strings (16 chars) for better UX.
+>
+> **Legacy note:** `verifyWhatsApp` is for older phone-bound token flows. Prefer inbound WhatsApp token confirmation plus status polling for new implementations.
 
 ### Google OAuth
 

package/openapi.yaml

@@ -8589,7 +8589,7 @@ paths:
     post:
       tags:
         - authKit
-      summary: Manually verify WhatsApp token if inbound webhook path is unavailable (public).
+      summary: Manually verify WhatsApp token if inbound webhook path is unavailable (legacy/public fallback).
       operationId: authKit_verifyWhatsApp
       security: []
       parameters:
@@ -17915,6 +17915,27 @@ components:
           $ref: "#/components/schemas/WhatsAppReplyCta"
         text:
           type: string
+    WhatsAppContactData:
+      type: object
+      properties:
+        name:
+          type: string
+        firstName:
+          type: string
+        lastName:
+          type: string
+        displayName:
+          type: string
+        email:
+          type: string
+        source:
+          type: string
+        customFields:
+          type: object
+          additionalProperties: true
+        externalIds:
+          type: object
+          additionalProperties: true
     SendWhatsAppRequest:
       type: object
       properties:
@@ -17924,6 +17945,8 @@ components:
           type: string
         reply:
           $ref: "#/components/schemas/WhatsAppReplyOptions"
+        contactData:
+          $ref: "#/components/schemas/WhatsAppContactData"
     SendWhatsAppResponse:
       type: object
       properties:

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@proveanything/smartlinks",
-  "version": "1.13.15",
+  "version": "1.13.16",
   "description": "Official JavaScript/TypeScript SDK for the Smartlinks API",
   "main": "dist/index.js",
   "types": "dist/index.d.ts",