vesant-sdk 1.8.0-dev.2b9e28d → 1.8.0-dev.69578db

package/dist/index.mjs

@@ -1657,17 +1657,27 @@ var RiskProfileClient = class extends BaseClient {
   /**
    * Update customer profile
    *
+   * Omitted fields keep their stored values. When the tenant has the
+   * **On Account Sensitive Action** KYC trigger enabled and the update changes
+   * the customer's name, date of birth or residential address, Vesant applies
+   * the other fields, holds the sensitive ones and answers `202` with a
+   * {@link ProfileUpdateHeldResponse} instead of the profile. Narrow with
+   * {@link isProfileUpdateHeld}, then request a `profile_change` submit link.
+   *
    * @param profileId - Profile UUID
    * @param updates - Fields to update
-   * @returns Updated customer profile
+   * @returns Updated customer profile, or the held change
    *
    * @example
    * ```typescript
-   * const updated = await client.updateProfile(profileId, {
+   * const result = await client.updateProfile(profileId, {
    *   location: 'New York, USA',
    *   location_compliance: 'compliant',
    *   last_recorded_activity: new Date().toISOString()
    * });
+   * if (isProfileUpdateHeld(result)) {
+   *   // name / DOB / address held: start KYC with trigger_event 'profile_change'
+   * }
    * ```
    */
   async updateProfile(profileId, updates, requestOptions) {
@@ -1707,6 +1717,11 @@ var RiskProfileClient = class extends BaseClient {
   }
 };
 
+// src/risk-profile/types.ts
+function isProfileUpdateHeld(result) {
+  return typeof result === "object" && result !== null && result.status === "kyc_required" && result.kyc_required === true;
+}
+
 // src/compliance/block-reasons.ts
 var sdkReasons = {
   // Jurisdiction
@@ -2237,11 +2252,12 @@ var ComplianceClient = class {
       if (profileResult) {
         profile = profileResult;
         if (!isBlocked && this.shouldUpdateProfile(profile, geoVerification.location.city)) {
-          profile = await this.riskClient.updateProfile(profile.id, {
+          const updated = await this.riskClient.updateProfile(profile.id, {
             last_recorded_activity: (/* @__PURE__ */ new Date()).toISOString(),
             location: `${geoVerification.location.city}, ${geoVerification.location.country}`,
             location_compliance: geoVerification.is_compliant ? "compliant" : "non-compliant"
           }, requestOptions);
+          profile = isProfileUpdateHeld(updated) ? updated.profile : updated;
         }
       } else {
         if (this.config.autoCreateProfiles && this.config.debug) {
@@ -3187,19 +3203,26 @@ var KycClient = class extends BaseClient {
     }, void 0, requestOptions);
   }
   /**
-   * Get a KYC request by ID
+   * Get a KYC record by ID
+   *
+   * Works with your tenant API key. Each entry in `proofs` carries a
+   * short-lived `link` for downloading that document, and `reference` holds
+   * your own customer reference (the `forward_reference`).
    *
-   * @param id - KYC request ID
-   * @returns KYC request details including proofs and alerts
+   * @param id - KYC record ID (the `kyc_id` returned by `requestKycSubmitLink`)
+   * @returns KYC record including proofs (with download links) and alerts
    *
    * @example
    * ```typescript
    * const kyc = await client.getKycRequest("550e8400-e29b-41d4-a716-446655440000");
    * console.log(`Status: ${kyc.status}, ID Verified: ${kyc.id_verified}`);
+   * kyc.proofs?.forEach(proof => console.log(`${proof.type}: ${proof.link}`));
    * ```
    */
   async getKycRequest(id) {
-    return this.request(`/api/v1/kyc/requests/${id}`);
+    return this.request(`/api/v1/kyc/${encodeURIComponent(id)}`, {
+      headers: this.getUserHeaders()
+    });
   }
   /**
    * List KYC requests with filters and pagination
@@ -3216,6 +3239,10 @@ var KycClient = class extends BaseClient {
    * );
    * console.log(`Found ${requests.total} pending requests`);
    * ```
+   *
+   * @remarks Console session only. This endpoint accepts a Vesant console
+   * (dashboard login) token, not a tenant API key; called with an API key it
+   * fails with `AuthenticationError` or a permission error.
    */
   async listKycRequests(filters, pagination) {
     const params = {};
@@ -3253,6 +3280,10 @@ var KycClient = class extends BaseClient {
    *   reason: "Document expired"
    * });
    * ```
+   *
+   * @remarks Console session only. This endpoint accepts a Vesant console
+   * (dashboard login) token, not a tenant API key; called with an API key it
+   * fails with `AuthenticationError` or a permission error.
    */
   async updateKycStatus(request) {
     await this.request("/api/v1/kyc/status", {
@@ -3289,22 +3320,24 @@ var KycClient = class extends BaseClient {
   /**
    * Get downloadable URLs for KYC proofs/documents
    *
-   * @param kycId - KYC request ID
-   * @returns Array of proof download URLs with expiration
+   * Derived from the `proofs` of `getKycRequest`: the platform attaches a
+   * short-lived download link to every proof on the KYC record, so no
+   * separate endpoint is needed. Proofs without a link are omitted.
+   *
+   * @param kycId - KYC record ID
+   * @returns Array of proof download URLs
    *
    * @example
    * ```typescript
    * const proofs = await client.getProofDownloadURLs("550e8400-e29b-41d4-a716-446655440000");
    * proofs.forEach(proof => {
-   *   console.log(`${proof.type}: ${proof.url} (expires: ${proof.expires_at})`);
+   *   console.log(`${proof.type}: ${proof.url}`);
    * });
    * ```
    */
   async getProofDownloadURLs(kycId) {
-    return this.request(
-      `/api/v1/kyc/proofs/${kycId}`,
-      { headers: this.getUserHeaders() }
-    );
+    const kyc = await this.getKycRequest(kycId);
+    return (kyc.proofs ?? []).filter((proof) => typeof proof.link === "string" && proof.link !== "").map((proof) => ({ id: proof.id, type: proof.type, url: proof.link }));
   }
   // ============================================================================
   // KYC Overview & Statistics
@@ -3325,6 +3358,10 @@ var KycClient = class extends BaseClient {
    * console.log(`Total: ${overview.total}, Pending: ${overview.pending}`);
    * console.log(`Approved: ${overview.approved}, Rejected: ${overview.rejected}`);
    * ```
+   *
+   * @remarks Console session only. This endpoint accepts a Vesant console
+   * (dashboard login) token, not a tenant API key; called with an API key it
+   * fails with `AuthenticationError` or a permission error.
    */
   async getOverview(fromDate, toDate) {
     const params = {};
@@ -3342,6 +3379,10 @@ var KycClient = class extends BaseClient {
    *
    * @param alertId - Alert ID
    * @returns Alert details
+   *
+   * @remarks Console session only. This endpoint accepts a Vesant console
+   * (dashboard login) token, not a tenant API key; called with an API key it
+   * fails with `AuthenticationError` or a permission error.
    */
   async getAlert(alertId) {
     return this.request(`/api/v1/kyc/alerts/${alertId}`);
@@ -3365,6 +3406,10 @@ var KycClient = class extends BaseClient {
    * );
    * console.log(`Found ${alerts.total} alerts`);
    * ```
+   *
+   * @remarks Console session only. This endpoint accepts a Vesant console
+   * (dashboard login) token, not a tenant API key; called with an API key it
+   * fails with `AuthenticationError` or a permission error.
    */
   async listAlerts(filters, pagination) {
     const params = {};
@@ -3411,6 +3456,10 @@ var KycClient = class extends BaseClient {
    *   reason: "Requires senior review - suspicious documents"
    * });
    * ```
+   *
+   * @remarks Console session only. This endpoint accepts a Vesant console
+   * (dashboard login) token, not a tenant API key; called with an API key it
+   * fails with `AuthenticationError` or a permission error.
    */
   async updateAlert(alertId, update) {
     await this.request(`/api/v1/kyc/alerts/${alertId}`, {
@@ -3433,6 +3482,10 @@ var KycClient = class extends BaseClient {
    * console.log(`Face verification required: ${prefs.is_face_verification_required}`);
    * console.log(`Required documents: ${prefs.required_document_count}`);
    * ```
+   *
+   * @remarks Console session only. This endpoint accepts a Vesant console
+   * (dashboard login) token, not a tenant API key; called with an API key it
+   * fails with `AuthenticationError` or a permission error.
    */
   async getPreferences() {
     return this.request("/api/v1/kyc/preferences");
@@ -3606,6 +3659,9 @@ var KYC_DECLINED_DESCRIPTIONS = {
 function isKycDocumentExpiredCallbackEvent(value) {
   return typeof value === "object" && value !== null && value.event === "kyc_document_expired";
 }
+function isProfileChangeCallbackEvent(value) {
+  return typeof value === "object" && value !== null && value.event === "profile_change";
+}
 
 // src/tax/client.ts
 var TaxClient = class extends BaseClient {
@@ -3900,6 +3956,6 @@ function isAmlBlockCallbackEvent(value) {
   return typeof value === "object" && value !== null && value.event === "aml" && value.block === true;
 }
 
-export { AuthenticationError, BaseClient, CGSError, CircuitBreaker, CircuitBreakerOpenError, ComplianceBlockedError, ComplianceClient, ComplianceError, DEFAULT_CURRENCY_RATES, GeolocationClient, InMemoryDedupStore, KYC_DECLINED_DESCRIPTIONS, KycClient, NetworkError, RateLimitError, RateLimitTracker, RefreshingTokenProvider, RiskProfileClient, SDK_VERSION, ServiceUnavailableError, StaticApiKeyProvider, TaxClient, TimeoutError, ValidationError, VesantError, WebhookHandler, assessGpsIntegrity, collectAll, collectDeviceSignals, createConsoleLogger, createNextWebhookHandler, createWebhookMiddleware, decodeCipherText, generateCipherText, gpsIntegrityInputFromPosition, isAmlBlockCallbackEvent, isCipherTextExpired, isKycDocumentExpiredCallbackEvent, noopLogger, paginate, probeGeolocationPermission, sdkReasons, verifyWebhookSignature };
+export { AuthenticationError, BaseClient, CGSError, CircuitBreaker, CircuitBreakerOpenError, ComplianceBlockedError, ComplianceClient, ComplianceError, DEFAULT_CURRENCY_RATES, GeolocationClient, InMemoryDedupStore, KYC_DECLINED_DESCRIPTIONS, KycClient, NetworkError, RateLimitError, RateLimitTracker, RefreshingTokenProvider, RiskProfileClient, SDK_VERSION, ServiceUnavailableError, StaticApiKeyProvider, TaxClient, TimeoutError, ValidationError, VesantError, WebhookHandler, assessGpsIntegrity, collectAll, collectDeviceSignals, createConsoleLogger, createNextWebhookHandler, createWebhookMiddleware, decodeCipherText, generateCipherText, gpsIntegrityInputFromPosition, isAmlBlockCallbackEvent, isCipherTextExpired, isKycDocumentExpiredCallbackEvent, isProfileChangeCallbackEvent, isProfileUpdateHeld, noopLogger, paginate, probeGeolocationPermission, sdkReasons, verifyWebhookSignature };
 //# sourceMappingURL=index.mjs.map
 //# sourceMappingURL=index.mjs.map