@verdocs/js-sdk 5.0.24 → 5.0.26

package/dist/index.d.mts

@@ -690,6 +690,8 @@ interface IRecipient {
     last_attempt_at?: string;
     /** The type of authentication required for this recipient. */
     auth_methods?: TRecipientAuthMethod[] | null;
+    /** The status of each auth method enabled. */
+    auth_method_states?: Record<TRecipientAuthMethod, string> | null;
     /**
      * If auth_method is set to "passcode" this is the passcode required. For security reasons, this
      * field will only be visible to the creator of the envelope.
@@ -700,14 +702,22 @@ interface IRecipient {
      * to allow for future expansion with authentication modules that may require multiple steps.
      */
     auth_step?: TRecipientAuthStep | null;
-    envelope?: IEnvelope;
-    profile?: IProfile;
     /**
      * Only returned in creation/getEnvelopeById requests by the creator. May be used for in-person signing. Note that
      * signing sessions started with this key will be marked as "In App" authenticated. For higher authentication levels,
      * e.g. email, the signer must follow a link send via the appropriate channel (email).
      */
     in_app_key?: string;
+    /**
+     * If KBA is enabled, any confirmation questions to challenge the recipient with.
+     */
+    kba_questions?: any;
+    /**
+     * Details related to the active KBA session, if any.
+     */
+    kba_details?: any;
+    envelope?: IEnvelope;
+    profile?: IProfile;
 }
 /**
  * A placeholder for an individual recipient, CC, or other party in a signing flow. Roles may be "known" or "unknown."
@@ -1827,6 +1837,8 @@ declare const getInPersonLink: (endpoint: VerdocsEndpoint, envelope_id: string,
  */
 declare const authenticateSigner: (endpoint: VerdocsEndpoint, params: TAuthenticateRecipientRequest) => Promise<{
     status: "OK";
+    auth_step: TRecipientAuthStep | null;
+    auth_details: any;
 }>;
 /**
  * Send a delegation request.

package/dist/index.d.ts

@@ -690,6 +690,8 @@ interface IRecipient {
     last_attempt_at?: string;
     /** The type of authentication required for this recipient. */
     auth_methods?: TRecipientAuthMethod[] | null;
+    /** The status of each auth method enabled. */
+    auth_method_states?: Record<TRecipientAuthMethod, string> | null;
     /**
      * If auth_method is set to "passcode" this is the passcode required. For security reasons, this
      * field will only be visible to the creator of the envelope.
@@ -700,14 +702,22 @@ interface IRecipient {
      * to allow for future expansion with authentication modules that may require multiple steps.
      */
     auth_step?: TRecipientAuthStep | null;
-    envelope?: IEnvelope;
-    profile?: IProfile;
     /**
      * Only returned in creation/getEnvelopeById requests by the creator. May be used for in-person signing. Note that
      * signing sessions started with this key will be marked as "In App" authenticated. For higher authentication levels,
      * e.g. email, the signer must follow a link send via the appropriate channel (email).
      */
     in_app_key?: string;
+    /**
+     * If KBA is enabled, any confirmation questions to challenge the recipient with.
+     */
+    kba_questions?: any;
+    /**
+     * Details related to the active KBA session, if any.
+     */
+    kba_details?: any;
+    envelope?: IEnvelope;
+    profile?: IProfile;
 }
 /**
  * A placeholder for an individual recipient, CC, or other party in a signing flow. Roles may be "known" or "unknown."
@@ -1827,6 +1837,8 @@ declare const getInPersonLink: (endpoint: VerdocsEndpoint, envelope_id: string,
  */
 declare const authenticateSigner: (endpoint: VerdocsEndpoint, params: TAuthenticateRecipientRequest) => Promise<{
     status: "OK";
+    auth_step: TRecipientAuthStep | null;
+    auth_details: any;
 }>;
 /**
  * Send a delegation request.

package/dist/index.js

@@ -1958,7 +1958,7 @@ const getInPersonLink = (endpoint, envelope_id, role_name) => endpoint.api //
  * @apiSuccess string . Success message
  */
 const authenticateSigner = (endpoint, params) => endpoint.api //
-    .post(`/v2/sign/authenticate`)
+    .post(`/v2/sign/authenticate`, params)
     .then((r) => r.data);
 /**
  * Send a delegation request.