vesant-sdk 1.7.0-dev.9b89b96 → 1.7.0-dev.a85efc5

package/dist/kyc/index.d.mts

@@ -57,6 +57,18 @@ interface KycRequest {
     other_reason?: string;
     /** @deprecated Use {@link warning_reasons}. */
     warnings?: Record<string, Record<string, string>>;
+    /**
+     * Tenant app should block onboarding/the action when true. Set when a
+     * failed verification matches a per-event KYC alert rule with the `block`
+     * reaction; sticky once set (a later non-blocking update won't clear it).
+     */
+    block: boolean;
+    /**
+     * Names the configured verification that triggered the block (e.g.
+     * `document_verification`, `face_verification`, `address_verification`,
+     * `age_verification`). Empty when {@link block} is false.
+     */
+    block_reason?: string;
     proofs?: Proof[];
     alerts?: KycAlert[];
     risk_profile?: KycCustomerProfile;
@@ -306,7 +318,14 @@ interface RequestKycSubmitLinkRequest {
     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") */
+    /**
+     * Event that triggered the KYC request. Valid values: "onboarding",
+     * "first_withdrawal", "first_purchase", "manual". The tenant's KYC
+     * verification trigger preferences decide, per event, whether KYC is
+     * required (`kyc_required` in the response). "manual" always requires
+     * KYC and honors the tenant's allow-skip-on-manual option (`can_skip`).
+     * Omitted or unknown values default to KYC required with no skip.
+     */
     trigger_event?: string;
 }
 /**
@@ -362,12 +381,34 @@ interface SubmitEventBasedFaceVerificationSessionRequest {
     proof: string;
     /** Unique reference for the KYC session (e.g., customer ID or transaction ID) */
     reference?: string;
+    /**
+     * Optional capture telemetry (JSON string): the face-detection
+     * bounding-box samples recorded in the moments before capture. Attached
+     * automatically by `FaceCaptureModal` when in-modal detection is active;
+     * omit when building a custom capture UI without detection. Stored
+     * verbatim server-side for audit/review — a weak presence signal, not
+     * certified anti-spoofing.
+     */
+    liveness_artifact?: string;
 }
 interface RequestKycSubmitLinkResponse {
     /** Generated KYC submission redirect URL */
     link: string;
     /** KYC request ID */
     kyc_id: string;
+    /**
+     * Whether KYC is required for the reported `trigger_event`, per the
+     * tenant's verification trigger preferences. `false` when the trigger
+     * is disabled for the tenant, or when the customer is already verified
+     * (in that case `link` and `kyc_id` are empty).
+     */
+    kyc_required: boolean;
+    /**
+     * Whether the user may skip verification. Only `true` for
+     * `trigger_event: "manual"` when the tenant enables allow-skip-on-manual,
+     * or when the customer is already verified.
+     */
+    can_skip: boolean;
 }
 /** Device class detected by the SDK (purely client-side — server doesn't care). */
 type EventBasedFaceVerificationDeviceType = 'mobile' | 'desktop';
@@ -414,6 +455,8 @@ interface EventBasedFaceVerificationReactionResult {
     trigger_alert: boolean;
     enforce_logout: boolean;
     freeze_account: boolean;
+    /** Tenant app should block the action/account when true. */
+    block: boolean;
     freeze_duration_minutes: number;
     /** Set when an alert was raised on the dashboard. */
     alert_id?: string;
@@ -428,6 +471,14 @@ interface EventBasedFaceVerificationCallback {
     reference: string;
     resource_id: string;
     status: KycStatus;
+    /**
+     * True when the tenant app should block the action/account. Mirrors the
+     * `block` reaction on {@link data} at the top level of the callback so
+     * consumers can branch without inspecting `data`. Omitted when false.
+     */
+    block?: boolean;
+    /** Names the event/verification that triggered the block. Omitted when not blocked. */
+    block_reason?: string;
     /** Structured decline reasons. */
     declined_reasons?: Reason[];
     /** @deprecated Use {@link declined_reasons}. */
@@ -767,7 +818,7 @@ declare class KycClient 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: {
@@ -793,7 +844,7 @@ declare class KycClient 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}`);
      * ```
      */
@@ -846,7 +897,7 @@ declare class KycClient 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"
      * });
@@ -861,7 +912,7 @@ declare class KycClient 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})`);
      * });

package/dist/kyc/index.d.ts

@@ -57,6 +57,18 @@ interface KycRequest {
     other_reason?: string;
     /** @deprecated Use {@link warning_reasons}. */
     warnings?: Record<string, Record<string, string>>;
+    /**
+     * Tenant app should block onboarding/the action when true. Set when a
+     * failed verification matches a per-event KYC alert rule with the `block`
+     * reaction; sticky once set (a later non-blocking update won't clear it).
+     */
+    block: boolean;
+    /**
+     * Names the configured verification that triggered the block (e.g.
+     * `document_verification`, `face_verification`, `address_verification`,
+     * `age_verification`). Empty when {@link block} is false.
+     */
+    block_reason?: string;
     proofs?: Proof[];
     alerts?: KycAlert[];
     risk_profile?: KycCustomerProfile;
@@ -306,7 +318,14 @@ interface RequestKycSubmitLinkRequest {
     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") */
+    /**
+     * Event that triggered the KYC request. Valid values: "onboarding",
+     * "first_withdrawal", "first_purchase", "manual". The tenant's KYC
+     * verification trigger preferences decide, per event, whether KYC is
+     * required (`kyc_required` in the response). "manual" always requires
+     * KYC and honors the tenant's allow-skip-on-manual option (`can_skip`).
+     * Omitted or unknown values default to KYC required with no skip.
+     */
     trigger_event?: string;
 }
 /**
@@ -362,12 +381,34 @@ interface SubmitEventBasedFaceVerificationSessionRequest {
     proof: string;
     /** Unique reference for the KYC session (e.g., customer ID or transaction ID) */
     reference?: string;
+    /**
+     * Optional capture telemetry (JSON string): the face-detection
+     * bounding-box samples recorded in the moments before capture. Attached
+     * automatically by `FaceCaptureModal` when in-modal detection is active;
+     * omit when building a custom capture UI without detection. Stored
+     * verbatim server-side for audit/review — a weak presence signal, not
+     * certified anti-spoofing.
+     */
+    liveness_artifact?: string;
 }
 interface RequestKycSubmitLinkResponse {
     /** Generated KYC submission redirect URL */
     link: string;
     /** KYC request ID */
     kyc_id: string;
+    /**
+     * Whether KYC is required for the reported `trigger_event`, per the
+     * tenant's verification trigger preferences. `false` when the trigger
+     * is disabled for the tenant, or when the customer is already verified
+     * (in that case `link` and `kyc_id` are empty).
+     */
+    kyc_required: boolean;
+    /**
+     * Whether the user may skip verification. Only `true` for
+     * `trigger_event: "manual"` when the tenant enables allow-skip-on-manual,
+     * or when the customer is already verified.
+     */
+    can_skip: boolean;
 }
 /** Device class detected by the SDK (purely client-side — server doesn't care). */
 type EventBasedFaceVerificationDeviceType = 'mobile' | 'desktop';
@@ -414,6 +455,8 @@ interface EventBasedFaceVerificationReactionResult {
     trigger_alert: boolean;
     enforce_logout: boolean;
     freeze_account: boolean;
+    /** Tenant app should block the action/account when true. */
+    block: boolean;
     freeze_duration_minutes: number;
     /** Set when an alert was raised on the dashboard. */
     alert_id?: string;
@@ -428,6 +471,14 @@ interface EventBasedFaceVerificationCallback {
     reference: string;
     resource_id: string;
     status: KycStatus;
+    /**
+     * True when the tenant app should block the action/account. Mirrors the
+     * `block` reaction on {@link data} at the top level of the callback so
+     * consumers can branch without inspecting `data`. Omitted when false.
+     */
+    block?: boolean;
+    /** Names the event/verification that triggered the block. Omitted when not blocked. */
+    block_reason?: string;
     /** Structured decline reasons. */
     declined_reasons?: Reason[];
     /** @deprecated Use {@link declined_reasons}. */
@@ -767,7 +818,7 @@ declare class KycClient 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: {
@@ -793,7 +844,7 @@ declare class KycClient 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}`);
      * ```
      */
@@ -846,7 +897,7 @@ declare class KycClient 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"
      * });
@@ -861,7 +912,7 @@ declare class KycClient 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})`);
      * });

package/dist/kyc/index.js

@@ -760,7 +760,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: {
@@ -792,7 +792,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}`);
    * ```
    */
@@ -867,7 +867,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"
    * });
@@ -888,7 +888,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})`);
    * });