vesant-sdk 1.8.0-dev.153299b → 1.8.0-dev.237d268

package/README.md

@@ -352,9 +352,11 @@ interface ComplianceClientConfig {
 | `requestKycSubmitLink(request)` | Generate a KYC submission link |
 | `checkKycStatus(request)` | Check KYC verification status |
 | `submitVerification(request)` | Submit document verification |
-| `listKycRequests(filters)` | List KYC requests |
-| `getPreferences()` | Get KYC preferences |
-| `listAlerts(filters)` | List KYC alerts |
+| `getKycRequest(id)` | Get a KYC record with proof download links |
+| `getProofDownloadURLs(id)` | Download links for a record's proofs |
+| `listKycRequests(filters)` | List KYC requests (console session only) |
+| `getPreferences()` | Get KYC preferences (console session only) |
+| `listAlerts(filters)` | List KYC alerts (console session only) |
 | `createEventBasedFaceVerificationSession(request)` | Start a face re-verification session (backend) |
 | `submitEventBasedFaceVerificationSession(request)` | Submit a face capture for a session |
 | `getEventBasedFaceVerificationSessionStatus(token)` | Look up a session's current result |

package/dist/index.js

@@ -3205,19 +3205,26 @@ var KycClient = class extends BaseClient {
     }, void 0, requestOptions);
   }
   /**
-   * Get a KYC request by ID
+   * Get a KYC record by ID
    *
-   * @param id - KYC request ID
-   * @returns KYC request details including proofs and alerts
+   * 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 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
@@ -3234,6 +3241,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 = {};
@@ -3271,6 +3282,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", {
@@ -3307,22 +3322,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
@@ -3343,6 +3360,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 = {};
@@ -3360,6 +3381,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}`);
@@ -3383,6 +3408,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 = {};
@@ -3429,6 +3458,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}`, {
@@ -3451,6 +3484,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");