vesant-sdk 1.7.0-dev.e0ee6d5 → 1.7.0-dev.e1da577

package/dist/kyc/index.mjs

@@ -601,7 +601,13 @@ var KycClient = class extends BaseClient {
    *
    * Generates a link that the user can visit to submit their KYC documents.
    *
-   * @param request - Request containing the user ID, optional redirect URL, and optional callback URL (receives POST requests)
+   * Optionally pass the customer's registered identity data as
+   * `customer_data` (same shape as the geolocation `customer_data` block).
+   * It seeds the customer's risk profile so document verification can
+   * cross-check the submitted document against trusted reference data;
+   * fields never overwrite data already on the profile.
+   *
+   * @param request - Request containing the user ID, optional redirect URL, optional callback URL (receives POST requests), and optional customer identity data
    * @returns Response containing the redirect link and KYC ID
    *
    * @example
@@ -609,7 +615,15 @@ var KycClient = class extends BaseClient {
    * const result = await client.requestKycSubmitLink({
    *   user_id: "user_123",
    *   redirect_url: "https://merchant.com/kyc-complete", // optional
-   *   callback_url: "https://merchant.com/api/kyc-webhook" // optional - receives POST requests on status change
+   *   callback_url: "https://merchant.com/api/kyc-webhook", // optional - receives POST requests on status change
+   *   customer_data: { // optional - seeds the risk profile for document cross-checks
+   *     full_name: "John Doe",
+   *     date_of_birth: "1999-06-02", // ISO 8601
+   *     email: "john@example.com",
+   *     phone: "+94771234567",
+   *     address: "12 Main St, Colombo", // used for address verification
+   *     country: "LK"
+   *   }
    * });
    *
    * console.log(`Redirect user to: ${result.link}`);
@@ -624,7 +638,7 @@ var KycClient = class extends BaseClient {
     });
   }
   /**
-   * Create a Re-Use KYC session.
+   * Create a Event-Based Face Verification session.
    *
    * Inspect the response before showing UI:
    * - `is_required === false` → skip face capture; `reason` explains why.
@@ -634,7 +648,7 @@ var KycClient = class extends BaseClient {
    *
    * @param request - Reference, customer_id, event, amount (for threshold events), optional URLs.
    */
-  async createReuseKycSession(request) {
+  async createEventBasedFaceVerificationSession(request) {
     return this.request("/api/v1/kyc/face/session", {
       method: "POST",
       body: JSON.stringify(request),
@@ -642,19 +656,19 @@ var KycClient = class extends BaseClient {
     });
   }
   /**
-   * Submit a real-time face capture for an active Re-Use KYC session.
+   * Submit a real-time face capture for an active Event-Based Face Verification session.
    *
    * **Mobile-only.** The server rejects desktop User-Agents with HTTP
    * 400 (`face capture must be completed on a mobile device`). Use the
-   * QR handoff from `createReuseKycSession` for desktop callers.
+   * QR handoff from `createEventBasedFaceVerificationSession` for desktop callers.
    *
    * The `data` field on the response carries `retries_remaining`,
    * `retry_limit_exceeded`, and the reaction flags (`enforce_logout`,
    * `freeze_account`, etc.) so the tenant app can act on a final failure.
    *
-   * @param request - Token from `createReuseKycSession`, plus the base64 selfie.
+   * @param request - Token from `createEventBasedFaceVerificationSession`, plus the base64 selfie.
    */
-  async submitReuseKycSession(request) {
+  async submitEventBasedFaceVerificationSession(request) {
     return this.request("/api/v1/kyc/face/submit", {
       method: "POST",
       body: JSON.stringify(request),
@@ -662,13 +676,17 @@ var KycClient = class extends BaseClient {
     });
   }
   /**
-   * Look up the current state of a Re-Use KYC session by its forward
-   * reference. Useful for desktop pollers waiting on the mobile handoff.
+   * Look up the current state of a Event-Based Face Verification session by its
+   * session token. Useful for desktop pollers waiting on the mobile handoff.
+   *
+   * The lookup is scoped by the unguessable, server-issued session token (not
+   * the enumerable forward reference): the endpoint is public/unauthenticated,
+   * and scoping by the token is what prevents cross-tenant status reads.
    *
-   * @param reference - The reference used when the session was created.
+   * @param token - The session token returned by `createEventBasedFaceVerificationSession`.
    */
-  async getReuseKycSessionStatus(reference) {
-    return this.requestWithRetry(`/api/v1/kyc/face/verify/${encodeURIComponent(reference)}`, {
+  async getEventBasedFaceVerificationSessionStatus(token) {
+    return this.requestWithRetry(`/api/v1/kyc/face/verify/${encodeURIComponent(token)}`, {
       method: "GET",
       headers: this.getUserHeaders()
     });
@@ -679,7 +697,7 @@ var KycClient = class extends BaseClient {
    * callers poll `mobile_connected` to detect when a mobile device has
    * scanned the QR and attached.
    *
-   * @param token - The session token returned by `createReuseKycSession`.
+   * @param token - The session token returned by `createEventBasedFaceVerificationSession`.
    */
   async getHandoffSession(token) {
     return this.request(
@@ -754,7 +772,7 @@ var KycClient = class extends BaseClient {
    * @example
    * ```typescript
    * const result = await client.submitVerification({
-   *   reference: "customer_123",
+   *   reference: "4d2aff34-ab86-422d-992e-50b1234a5b67",
    *   email: "customer@example.com",
    *   country: "US",
    *   document: {
@@ -786,7 +804,7 @@ var KycClient = class extends BaseClient {
    *
    * @example
    * ```typescript
-   * const kyc = await client.getKycRequest("kyc_abc123");
+   * const kyc = await client.getKycRequest("550e8400-e29b-41d4-a716-446655440000");
    * console.log(`Status: ${kyc.status}, ID Verified: ${kyc.id_verified}`);
    * ```
    */
@@ -861,7 +879,7 @@ var KycClient = class extends BaseClient {
    * @example
    * ```typescript
    * await client.requestAdditionalDocuments({
-   *   id: "kyc_abc123",
+   *   id: "550e8400-e29b-41d4-a716-446655440000",
    *   document_types: ["address", "document_two"],
    *   message: "Please provide proof of address and secondary ID"
    * });
@@ -882,7 +900,7 @@ var KycClient = class extends BaseClient {
    *
    * @example
    * ```typescript
-   * const proofs = await client.getProofDownloadURLs("kyc_abc123");
+   * const proofs = await client.getProofDownloadURLs("550e8400-e29b-41d4-a716-446655440000");
    * proofs.forEach(proof => {
    *   console.log(`${proof.type}: ${proof.url} (expires: ${proof.expires_at})`);
    * });