vesant-sdk 1.6.6 → 2.0.0-dev.37c7832

package/dist/kyc/index.d.ts

@@ -1,6 +1,6 @@
-import { R as RiskLevel, P as PaginationParams } from '../types-B4Ezqo7V.js';
-import { e as ProfileFilters, f as ProfileListResponse, C as CustomerProfile, d as CreateProfileRequest } from '../types-X5Md_dD_.js';
-import { B as BaseClient } from '../client-ePzhQKp9.js';
+import { P as ProfileFilters, b as ProfileListResponse, C as CustomerProfile, a as CreateProfileRequest } from '../types-2utj53GK.js';
+import { R as RiskLevel, P as PaginationParams } from '../types-QUCWam16.js';
+import { B as BaseClient } from '../client-BolQlL5e.js';
 
 /**
  * TypeScript type definitions for Vesant KYC Service API
@@ -12,12 +12,13 @@ import { B as BaseClient } from '../client-ePzhQKp9.js';
  */
 
 type KycStatus = 'pending' | 'accepted' | 'declined' | 'review.pending' | 'unknown';
+type KycDeclinedCode = 'KYC_DOCUMENT_EXPIRED' | 'KYC_DOCUMENT_INVALID' | 'KYC_FACE_MISMATCH' | 'KYC_AGE_REQUIREMENT' | 'KYC_DUPLICATE_IDENTITY' | 'KYC_ADDRESS_MISMATCH' | 'KYC_NAME_MISMATCH' | 'KYC_PROVIDER_REJECTED' | 'KYC_DECLINED';
+declare const KYC_DECLINED_DESCRIPTIONS: Record<KycDeclinedCode, string>;
 type KycAlertStatus = 'pending' | 'in_progress' | 'resolved' | 'closed' | 'escalated';
 type KycAlertType = 'kyc' | 'fraud';
 type DocumentType = 'id_card' | 'driving_license' | 'passport';
 type ProofType = 'document' | 'document_two' | 'face' | 'address' | 'additional_document';
 type SupportedDocumentType = 'id_card' | 'passport' | 'driving_license';
-type KycTriggerEvent = 'onboarding' | 'first_withdrawal' | 'first_purchase' | 'manual' | 'withdrawal' | 'purchase';
 interface KycRequest {
     id: string;
     reference: string;
@@ -45,6 +46,7 @@ interface KycRequest {
     callback_url: string;
     redirect_url?: string;
     declined_reason?: string;
+    declined_code?: KycDeclinedCode;
     accepted_reason?: string;
     other_reason?: string;
     warnings?: Record<string, Record<string, string>>;
@@ -223,12 +225,12 @@ interface UpdateKycStatusRequest {
 interface RequestKycSubmitLinkRequest {
     /** User ID to generate KYC submission link for */
     user_id: string;
-    /** URL to redirect user after KYC submission */
-    redirect_url: string;
-    /** URL to receive callback notifications via POST request when KYC status changes */
-    callback_url: string;
-    /** Event that triggered the KYC request */
-    trigger_event: KycTriggerEvent;
+    /** URL to redirect user after KYC submission (optional) */
+    redirect_url?: string;
+    /** URL to receive callback notifications via POST request when KYC status changes (optional) */
+    callback_url?: string;
+    /** Event that triggered the KYC request (e.g. "onboarding", "login", "transaction") */
+    trigger_event?: string;
 }
 interface CreateReuseKycSessionRequest {
     /** Unique reference for the KYC session (e.g., customer ID or transaction ID) */
@@ -251,14 +253,10 @@ interface SubmitReuseKycSessionRequest {
     reference?: string;
 }
 interface RequestKycSubmitLinkResponse {
-    /** Whether KYC is required for this user */
-    kyc_required: boolean;
-    /** Whether the user can skip KYC */
-    can_skip: boolean;
     /** Generated KYC submission redirect URL */
-    link?: string;
+    link: string;
     /** KYC request ID */
-    kyc_id?: string;
+    kyc_id: string;
 }
 interface CreateReuseKycSessionResponse {
     /** Generated reuse KYC session token, valid X minutes */
@@ -290,6 +288,7 @@ interface CheckKycStatusResponse {
     face_verified: boolean;
     age_verified: boolean;
     declined_reason?: string;
+    declined_code?: KycDeclinedCode;
     other_reason?: string;
     accepted_reason?: string;
     warnings?: Record<string, Record<string, string>>;
@@ -461,23 +460,19 @@ declare class KycClient extends BaseClient {
      *
      * Generates a link that the user can visit to submit their KYC documents.
      *
-     * @param request - Request containing the user ID, redirect URL, callback URL, and trigger event
-     * @returns Response containing kyc_required, can_skip, and optionally the redirect link and KYC ID
+     * @param request - Request containing the user ID, optional redirect URL, and optional callback URL (receives POST requests)
+     * @returns Response containing the redirect link and KYC ID
      *
      * @example
      * ```typescript
      * const result = await client.requestKycSubmitLink({
      *   user_id: "user_123",
-     *   redirect_url: "https://merchant.com/kyc-complete",
-     *   callback_url: "https://merchant.com/api/kyc-webhook",
-     *   trigger_event: "onboarding"
+     *   redirect_url: "https://merchant.com/kyc-complete", // optional
+     *   callback_url: "https://merchant.com/api/kyc-webhook" // optional - receives POST requests on status change
      * });
      *
-     * if (result.kyc_required && result.link) {
-     *   console.log(`Redirect user to: ${result.link}`);
-     * } else if (result.can_skip) {
-     *   console.log("KYC not required, user can proceed");
-     * }
+     * console.log(`Redirect user to: ${result.link}`);
+     * console.log(`KYC ID: ${result.kyc_id}`);
      * ```
      */
     requestKycSubmitLink(request: RequestKycSubmitLinkRequest): Promise<RequestKycSubmitLinkResponse>;
@@ -819,4 +814,4 @@ declare class KycClient extends BaseClient {
     createCustomerProfile(profile: CreateProfileRequest): Promise<CustomerProfile>;
 }
 
-export { type CheckKycStatusRequest, type CheckKycStatusResponse, CreateProfileRequest as CreateCustomerProfileRequest, type CreateReuseKycSessionRequest, type CreateReuseKycSessionResponse, CustomerProfile, ProfileFilters as CustomerProfileFilters, ProfileListResponse as CustomerProfileListResponse, type DocumentType, type DocumentVerificationRequest, type DocumentVerificationResponse, type FaceProof, type KycAlert, type KycAlertFilters, type KycAlertListResponse, type KycAlertStatus, type KycAlertType, KycClient, type KycClientConfig, type KycCustomerProfile, type KycOverview, type KycPagination, type KycPreferences, type KycRequest, type KycRequestFilters, type KycRequestListResponse, type KycStatus, type KycTriggerEvent, type Name, PaginationParams, type Proof, type ProofDownloadURL, type ProofType, type RequestAdditionalDocumentsRequest, type RequestKycSubmitLinkRequest, type RequestKycSubmitLinkResponse, RiskLevel, type SubmitReuseKycSessionRequest, type SubmittedDocument, type SupportedDocumentType, type UpdateKycAlertRequest, type UpdateKycPreferencesRequest, type UpdateKycStatusRequest, type UseKycAlertsOptions, type UseKycAlertsResult, type UseKycOverviewOptions, type UseKycOverviewResult, type UseKycPreferencesResult, type UseKycRequestsOptions, type UseKycRequestsResult, type UseKycSubmissionOptions, type UseKycSubmissionResult };
+export { type CheckKycStatusRequest, type CheckKycStatusResponse, CreateProfileRequest as CreateCustomerProfileRequest, type CreateReuseKycSessionRequest, type CreateReuseKycSessionResponse, CustomerProfile, ProfileFilters as CustomerProfileFilters, ProfileListResponse as CustomerProfileListResponse, type DocumentType, type DocumentVerificationRequest, type DocumentVerificationResponse, type FaceProof, KYC_DECLINED_DESCRIPTIONS, type KycAlert, type KycAlertFilters, type KycAlertListResponse, type KycAlertStatus, type KycAlertType, KycClient, type KycClientConfig, type KycCustomerProfile, type KycDeclinedCode, type KycOverview, type KycPagination, type KycPreferences, type KycRequest, type KycRequestFilters, type KycRequestListResponse, type KycStatus, type Name, PaginationParams, type Proof, type ProofDownloadURL, type ProofType, type RequestAdditionalDocumentsRequest, type RequestKycSubmitLinkRequest, type RequestKycSubmitLinkResponse, RiskLevel, type SubmitReuseKycSessionRequest, type SubmittedDocument, type SupportedDocumentType, type UpdateKycAlertRequest, type UpdateKycPreferencesRequest, type UpdateKycStatusRequest, type UseKycAlertsOptions, type UseKycAlertsResult, type UseKycOverviewOptions, type UseKycOverviewResult, type UseKycPreferencesResult, type UseKycRequestsOptions, type UseKycRequestsResult, type UseKycSubmissionOptions, type UseKycSubmissionResult };

package/dist/kyc/index.js

@@ -216,7 +216,7 @@ function createConsoleLogger() {
 }
 
 // src/core/version.ts
-var SDK_VERSION = "1.6.6";
+var SDK_VERSION = "2.0.0";
 
 // src/shared/browser-utils.ts
 function generateUUID() {
@@ -603,23 +603,19 @@ 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, redirect URL, callback URL, and trigger event
-   * @returns Response containing kyc_required, can_skip, and optionally the redirect link and KYC ID
+   * @param request - Request containing the user ID, optional redirect URL, and optional callback URL (receives POST requests)
+   * @returns Response containing the redirect link and KYC ID
    *
    * @example
    * ```typescript
    * const result = await client.requestKycSubmitLink({
    *   user_id: "user_123",
-   *   redirect_url: "https://merchant.com/kyc-complete",
-   *   callback_url: "https://merchant.com/api/kyc-webhook",
-   *   trigger_event: "onboarding"
+   *   redirect_url: "https://merchant.com/kyc-complete", // optional
+   *   callback_url: "https://merchant.com/api/kyc-webhook" // optional - receives POST requests on status change
    * });
    *
-   * if (result.kyc_required && result.link) {
-   *   console.log(`Redirect user to: ${result.link}`);
-   * } else if (result.can_skip) {
-   *   console.log("KYC not required, user can proceed");
-   * }
+   * console.log(`Redirect user to: ${result.link}`);
+   * console.log(`KYC ID: ${result.kyc_id}`);
    * ```
    */
   async requestKycSubmitLink(request) {
@@ -1022,8 +1018,9 @@ var KycClient = class extends BaseClient {
    */
   async riskProfileRequest(path, options = {}) {
     if (!this.riskProfileBaseURL) {
-      throw new Error(
-        "Risk Profile Service URL not configured. Please provide riskProfileBaseURL in KycClientConfig."
+      throw new ValidationError(
+        "Risk Profile Service URL not configured. Please provide riskProfileBaseURL in KycClientConfig.",
+        ["riskProfileBaseURL"]
       );
     }
     return this.request(path, {
@@ -1135,6 +1132,20 @@ var KycClient = class extends BaseClient {
   // ============================================================================
 };
 
+// src/kyc/types.ts
+var KYC_DECLINED_DESCRIPTIONS = {
+  KYC_DOCUMENT_EXPIRED: "The submitted document has expired",
+  KYC_DOCUMENT_INVALID: "The submitted document could not be verified",
+  KYC_FACE_MISMATCH: "Face verification did not match the identity document",
+  KYC_AGE_REQUIREMENT: "Age requirement not met",
+  KYC_DUPLICATE_IDENTITY: "This identity has already been verified under another account",
+  KYC_ADDRESS_MISMATCH: "Address verification failed",
+  KYC_NAME_MISMATCH: "Name on document does not match the registered name",
+  KYC_PROVIDER_REJECTED: "Identity verification was rejected by the verification provider",
+  KYC_DECLINED: "Identity verification was declined"
+};
+
+exports.KYC_DECLINED_DESCRIPTIONS = KYC_DECLINED_DESCRIPTIONS;
 exports.KycClient = KycClient;
 //# sourceMappingURL=index.js.map
 //# sourceMappingURL=index.js.map