@verdocs/js-sdk 5.0.16 → 5.0.17

package/dist/index.d.mts

@@ -696,6 +696,14 @@ interface IRecipient {
      * field will only be visible to the creator of the envelope.
      */
     passcode?: string | null;
+    /**
+     * If SMS-based authentication is used, the phone number to which one-time codes should be sent.
+     * NOTE: This may be different from the phone number used for notifications, but leaving it blank
+     * will trigger an error rather than defaulting to the notifications phone number to avoid mistaken
+     * assumptions (e.g. if SMS notifications are not enabled for the organization, but SMS authentication
+     * is).
+     */
+    phone_auth?: string;
     /**
      * If authentication has been completed successfully, this will be set to 'complete'. This is a union type
      * to allow for future expansion with authentication modules that may require multiple steps.
@@ -703,6 +711,12 @@ interface IRecipient {
     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;
 }
 /**
  * A placeholder for an individual recipient, CC, or other party in a signing flow. Roles may be "known" or "unknown."
@@ -944,7 +958,7 @@ type TFieldType = "signature" | "initial" | "checkbox" | "radio" | "textbox" | "
 type TWebhookEvent = "envelope_created" | "envelope_completed" | "envelope_canceled" | "envelope_updated" | "template_created" | "template_updated" | "template_deleted" | "template_used";
 type TTemplateVisibility = "private" | "shared" | "public";
 type TEntitlement = "envelope" | "kba_auth" | "passcode_auth" | "sms_auth" | "kba_id_auth" | "id_auth";
-type TRecipientAuthMethod = "kba_auth" | "passcode_auth" | "sms_auth" | "kba_id_auth" | "id_auth" | null;
+type TRecipientAuthMethod = "kba" | "passcode" | "sms" | "id" | "kba_id" | null;
 type TRecipientAuthStep = "complete" | null;
 declare const FIELD_TYPES: TFieldType[];
 declare const DEFAULT_FIELD_WIDTHS: Record<TFieldType, number>;
@@ -1212,26 +1226,29 @@ interface ICreateEnvelopeRecipient {
     delegator?: boolean;
     /** A custom message to include in the email or SMS invitation. May be left blank for a default message. */
     message?: string;
-    /** To enable KBA for the recipient, set to 'pin' or 'identity'. */
-    kba_method?: "pin" | "identity" | null;
-    /** If PIN-based KBA is used, the PIN to challenge the user to enter. */
-    kba_pin?: string;
+    /** To enable authentication for the recipient, set to 'pin' or 'identity'. */
+    auth_method?: TRecipientAuthMethod;
+    /** If Passcode-based authentication is used, the passcode to challenge the user to enter. */
+    passcode?: string;
+    /**
+     * If SMS-based authentication is used, the phone number to which one-time codes should be sent.
+     * NOTE: This may be different from the phone number used for notifications, but leaving it blank
+     * will trigger an error rather than defaulting to the notifications phone number to avoid mistaken
+     * assumptions (e.g. if SMS notifications are not enabled for the organization, but SMS authentication
+     * is).
+     */
+    phone_auth?: string;
     /*
-    * Pre-fill data for the recipient, if known. NOTE: If address and zip are both provided, an initial ID query
-    * will be made for the recipient. If questions are returned immediately, the first challenge will be skipped and
-    * the recipient will be immediately shown those questions, instead.
+    * Pre-fill data for the recipient, if known. NOTE: Even when pre-filling these fields for a recipient, if
+    * KBA is enabled, the recipient must be provided with the option to confirm those details before proceeding,
+    * provide at least one data point themselves (typically date of birth). Providing every value here will
+    trigger an error.
     */
     address?: string;
     city?: string;
     state?: string;
     zip?: string;
-    ssn_last_4?: string;
-    /**
-     * 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;
+    dob?: string;
 }
 interface ISignerTokenResponse {
     /**

package/dist/index.d.ts

@@ -696,6 +696,14 @@ interface IRecipient {
      * field will only be visible to the creator of the envelope.
      */
     passcode?: string | null;
+    /**
+     * If SMS-based authentication is used, the phone number to which one-time codes should be sent.
+     * NOTE: This may be different from the phone number used for notifications, but leaving it blank
+     * will trigger an error rather than defaulting to the notifications phone number to avoid mistaken
+     * assumptions (e.g. if SMS notifications are not enabled for the organization, but SMS authentication
+     * is).
+     */
+    phone_auth?: string;
     /**
      * If authentication has been completed successfully, this will be set to 'complete'. This is a union type
      * to allow for future expansion with authentication modules that may require multiple steps.
@@ -703,6 +711,12 @@ interface IRecipient {
     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;
 }
 /**
  * A placeholder for an individual recipient, CC, or other party in a signing flow. Roles may be "known" or "unknown."
@@ -944,7 +958,7 @@ type TFieldType = "signature" | "initial" | "checkbox" | "radio" | "textbox" | "
 type TWebhookEvent = "envelope_created" | "envelope_completed" | "envelope_canceled" | "envelope_updated" | "template_created" | "template_updated" | "template_deleted" | "template_used";
 type TTemplateVisibility = "private" | "shared" | "public";
 type TEntitlement = "envelope" | "kba_auth" | "passcode_auth" | "sms_auth" | "kba_id_auth" | "id_auth";
-type TRecipientAuthMethod = "kba_auth" | "passcode_auth" | "sms_auth" | "kba_id_auth" | "id_auth" | null;
+type TRecipientAuthMethod = "kba" | "passcode" | "sms" | "id" | "kba_id" | null;
 type TRecipientAuthStep = "complete" | null;
 declare const FIELD_TYPES: TFieldType[];
 declare const DEFAULT_FIELD_WIDTHS: Record<TFieldType, number>;
@@ -1212,26 +1226,29 @@ interface ICreateEnvelopeRecipient {
     delegator?: boolean;
     /** A custom message to include in the email or SMS invitation. May be left blank for a default message. */
     message?: string;
-    /** To enable KBA for the recipient, set to 'pin' or 'identity'. */
-    kba_method?: "pin" | "identity" | null;
-    /** If PIN-based KBA is used, the PIN to challenge the user to enter. */
-    kba_pin?: string;
+    /** To enable authentication for the recipient, set to 'pin' or 'identity'. */
+    auth_method?: TRecipientAuthMethod;
+    /** If Passcode-based authentication is used, the passcode to challenge the user to enter. */
+    passcode?: string;
+    /**
+     * If SMS-based authentication is used, the phone number to which one-time codes should be sent.
+     * NOTE: This may be different from the phone number used for notifications, but leaving it blank
+     * will trigger an error rather than defaulting to the notifications phone number to avoid mistaken
+     * assumptions (e.g. if SMS notifications are not enabled for the organization, but SMS authentication
+     * is).
+     */
+    phone_auth?: string;
     /*
-    * Pre-fill data for the recipient, if known. NOTE: If address and zip are both provided, an initial ID query
-    * will be made for the recipient. If questions are returned immediately, the first challenge will be skipped and
-    * the recipient will be immediately shown those questions, instead.
+    * Pre-fill data for the recipient, if known. NOTE: Even when pre-filling these fields for a recipient, if
+    * KBA is enabled, the recipient must be provided with the option to confirm those details before proceeding,
+    * provide at least one data point themselves (typically date of birth). Providing every value here will
+    trigger an error.
     */
     address?: string;
     city?: string;
     state?: string;
     zip?: string;
-    ssn_last_4?: string;
-    /**
-     * 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;
+    dob?: string;
 }
 interface ISignerTokenResponse {
     /**

package/dist/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@verdocs/js-sdk",
-  "version": "5.0.16",
+  "version": "5.0.17",
   "private": false,
   "homepage": "https://github.com/Verdocs/js-sdk",
   "description": "Isomorphic JS/TS SDK providing types and API wrappers for the Verdocs platform for Node and browser clients",

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@verdocs/js-sdk",
-  "version": "5.0.16",
+  "version": "5.0.17",
   "private": false,
   "homepage": "https://github.com/Verdocs/js-sdk",
   "description": "Isomorphic JS/TS SDK providing types and API wrappers for the Verdocs platform for Node and browser clients",