@verdocs/js-sdk 5.0.22 → 5.0.23

package/dist/index.d.mts

@@ -1264,6 +1264,15 @@ interface ISignerTokenResponse {
      * a signing session is being started, so it is included here for convenience.
      */
     recipient: IRecipient;
+    /**
+     * The next authentication step the recipient must perform, or null if no auth steps are needed.
+     */
+    auth_step: TRecipientAuthMethod | null;
+    /**
+     * If an authentication step must be performed, details related to it. Open-ended type to support
+     * the modularity of the authentication system.
+     */
+    auth_details: Record<string, any> | null;
 }
 interface IInPersonLinkResponse {
     /** A valid Verdocs Web URL that hosts a signing experience. */
@@ -1659,7 +1668,7 @@ type TRecipientKbaStep = IRecipientKbaStepNone | IRecipientKbaStepComplete | IRe
  * Get the current KBA status. Note that this may only be called by the recipient and requires a
  * valid signing session to proceed. Although the Recipient object itself contains indications of
  * whether KBA is required, it will not contain the current status of the process. If
- * `recipient.kba_method` is set (not null), and `recipient.kba_completed` is false, this endpoint
+ * `recipient.auth_methods` is set (not empty), and `recipient.kba_completed` is false, this endpoint
  * should be called to determine the next KBA step required.
  */
 declare const getKbaStep: (endpoint: VerdocsEndpoint, envelope_id: string, role_name: string) => Promise<IRecipientKbaStepNone | IRecipientKbaStepComplete | IRecipientKbaStepPin | IRecipientKbaStepIdentity | IRecipientKbaStepChallenge | IRecipientKbaStepFailed>;
@@ -2890,7 +2899,6 @@ declare const userCanPreviewTemplate: (profile: IProfile | null | undefined, tem
  * @apiBody integer(min: 1, default: 1) sequence? Optional 1-based sequence number for the role. Roles that share the same sequence number act in parallel, and will receive invitations at the same time.
  * @apiBody integer(min: 1, default: 1) order? Optional 1-based order number for the role. Controls the left-to-right display order of roles at the same sequence number in the UI components e.g. `<verdocs-template-roles />`.
  * @apiBody boolean delegator? If true, the role may delegate their signing responsibility to another party.
- * @apiBody string(enum:'pin'|'identity'|'') kba_method? Active PIN- or Identity-based KBA for the role. NOTE: Some KBA operations may incur additional fees.
  * @apiSuccess IRole . The newly-created role
  */
 declare const createTemplateRole: (endpoint: VerdocsEndpoint, template_id: string, params: IRole) => Promise<IRole>;

package/dist/index.d.ts

@@ -1264,6 +1264,15 @@ interface ISignerTokenResponse {
      * a signing session is being started, so it is included here for convenience.
      */
     recipient: IRecipient;
+    /**
+     * The next authentication step the recipient must perform, or null if no auth steps are needed.
+     */
+    auth_step: TRecipientAuthMethod | null;
+    /**
+     * If an authentication step must be performed, details related to it. Open-ended type to support
+     * the modularity of the authentication system.
+     */
+    auth_details: Record<string, any> | null;
 }
 interface IInPersonLinkResponse {
     /** A valid Verdocs Web URL that hosts a signing experience. */
@@ -1659,7 +1668,7 @@ type TRecipientKbaStep = IRecipientKbaStepNone | IRecipientKbaStepComplete | IRe
  * Get the current KBA status. Note that this may only be called by the recipient and requires a
  * valid signing session to proceed. Although the Recipient object itself contains indications of
  * whether KBA is required, it will not contain the current status of the process. If
- * `recipient.kba_method` is set (not null), and `recipient.kba_completed` is false, this endpoint
+ * `recipient.auth_methods` is set (not empty), and `recipient.kba_completed` is false, this endpoint
  * should be called to determine the next KBA step required.
  */
 declare const getKbaStep: (endpoint: VerdocsEndpoint, envelope_id: string, role_name: string) => Promise<IRecipientKbaStepNone | IRecipientKbaStepComplete | IRecipientKbaStepPin | IRecipientKbaStepIdentity | IRecipientKbaStepChallenge | IRecipientKbaStepFailed>;
@@ -2890,7 +2899,6 @@ declare const userCanPreviewTemplate: (profile: IProfile | null | undefined, tem
  * @apiBody integer(min: 1, default: 1) sequence? Optional 1-based sequence number for the role. Roles that share the same sequence number act in parallel, and will receive invitations at the same time.
  * @apiBody integer(min: 1, default: 1) order? Optional 1-based order number for the role. Controls the left-to-right display order of roles at the same sequence number in the UI components e.g. `<verdocs-template-roles />`.
  * @apiBody boolean delegator? If true, the role may delegate their signing responsibility to another party.
- * @apiBody string(enum:'pin'|'identity'|'') kba_method? Active PIN- or Identity-based KBA for the role. NOTE: Some KBA operations may incur additional fees.
  * @apiSuccess IRole . The newly-created role
  */
 declare const createTemplateRole: (endpoint: VerdocsEndpoint, template_id: string, params: IRole) => Promise<IRole>;

package/dist/index.js

@@ -1825,7 +1825,7 @@ const createInitials = (endpoint, name, initials) => {
  * Get the current KBA status. Note that this may only be called by the recipient and requires a
  * valid signing session to proceed. Although the Recipient object itself contains indications of
  * whether KBA is required, it will not contain the current status of the process. If
- * `recipient.kba_method` is set (not null), and `recipient.kba_completed` is false, this endpoint
+ * `recipient.auth_methods` is set (not empty), and `recipient.kba_completed` is false, this endpoint
  * should be called to determine the next KBA step required.
  */
 const getKbaStep = (endpoint, envelope_id, role_name) => endpoint.api //
@@ -3121,7 +3121,6 @@ const userCanPreviewTemplate = (profile, template) => {
  * @apiBody integer(min: 1, default: 1) sequence? Optional 1-based sequence number for the role. Roles that share the same sequence number act in parallel, and will receive invitations at the same time.
  * @apiBody integer(min: 1, default: 1) order? Optional 1-based order number for the role. Controls the left-to-right display order of roles at the same sequence number in the UI components e.g. `<verdocs-template-roles />`.
  * @apiBody boolean delegator? If true, the role may delegate their signing responsibility to another party.
- * @apiBody string(enum:'pin'|'identity'|'') kba_method? Active PIN- or Identity-based KBA for the role. NOTE: Some KBA operations may incur additional fees.
  * @apiSuccess IRole . The newly-created role
  */
 const createTemplateRole = (endpoint, template_id, params) => endpoint.api //