@verdocs/js-sdk 4.2.42 → 4.2.44

package/dist/index.d.mts

@@ -153,6 +153,7 @@ interface ISigningSession {
     email: string;
     iat: number;
     exp: number;
+    "https://verdocs.com/key_type": TAccessKeyType;
     "https://verdocs.com/session_type": "signing";
     "https://verdocs.com/envelope_id": string;
     "https://verdocs.com/role_name": string;
@@ -462,18 +463,18 @@ interface IEnvelope {
     organization_id: string;
     reminder_id: string | null;
     name: string;
-    no_contact: boolean;
+    no_contact?: boolean;
     created_at: string;
     updated_at: string;
     canceled_at: string;
     /** Defaults to 'private'. If set to 'shared', this envelope will be visible to other users in the same organization. Ignored for personal profiles. */
     visibility: "private" | "shared";
-    search_key: string | null;
+    search_key?: string | null;
     /**
      * Storage for arbitrary data that may be used e.g. to track source database/record IDs to relate Envelopes back to
      * internal systems/applications.
      */
-    data: Record<string, any> | null;
+    data?: Record<string, any> | null;
     profile?: IProfile;
     template?: ITemplate | null;
     organization?: IOrganization;
@@ -606,6 +607,8 @@ interface IKbaPINRequired {
     type: "pin";
 }
 interface IRecipient {
+    /** Used only by the Web SDK during builder processes. Not stored in the backend. */
+    id?: string | null;
     envelope_id: string;
     role_name: string;
     profile_id: string;
@@ -685,6 +688,8 @@ interface IReminder {
  * "Unknown" roles are dynamic, and will be filled in later when the envelope is created.
  */
 interface IRole {
+    /** Used only by the Web SDK during builder processes. Not stored in the backend. */
+    id?: string | null;
     template_id: string;
     // The name of the recipient. Note that recipients do not have a separate ID - they are uniquely identified by name.
     name: string;
@@ -1140,7 +1145,7 @@ interface ICreateEnvelopeRecipient {
      * The Role name of the recipient. Please note this is not the person's name. It is the ID of the role, e.g.
      * 'Recipient 1', 'Seller', etc. This must match one of the pre-defined roles in the template's Recipients list.
      */
-    name: string;
+    role_name: string;
     /** The name of the recipient as it will be displayed in reports and queries, e.g. 'Paige Turner'. */
     first_name: string;
     last_name: string;
@@ -1171,6 +1176,22 @@ interface ICreateEnvelopeRecipient {
     kba_method?: "pin" | "identity" | null;
     /** If PIN-based KBA is used, the PIN to challenge the user to enter. */
     kba_pin?: 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.
+    */
+    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;
 }
 interface IInPersonLinkResponse {
     link: string;
@@ -1492,10 +1513,8 @@ declare const envelopeRecipientUpdateName: (endpoint: VerdocsEndpoint, envelopeI
  */
 declare const envelopeRecipientPrepare: (endpoint: VerdocsEndpoint, envelopeId: string, roleName: string, recipients: IRecipient[]) => Promise<IRecipient>;
 interface ISignerTokenResponse {
-    recipient: IRecipient;
     envelope: IEnvelope;
     access_token: string;
-    in_person_key: IInPersonAccessKey;
 }
 /**
  * Get a signing session for an Envelope. Note that this should generally be called with a NON-default

package/dist/index.d.ts

@@ -153,6 +153,7 @@ interface ISigningSession {
     email: string;
     iat: number;
     exp: number;
+    "https://verdocs.com/key_type": TAccessKeyType;
     "https://verdocs.com/session_type": "signing";
     "https://verdocs.com/envelope_id": string;
     "https://verdocs.com/role_name": string;
@@ -462,18 +463,18 @@ interface IEnvelope {
     organization_id: string;
     reminder_id: string | null;
     name: string;
-    no_contact: boolean;
+    no_contact?: boolean;
     created_at: string;
     updated_at: string;
     canceled_at: string;
     /** Defaults to 'private'. If set to 'shared', this envelope will be visible to other users in the same organization. Ignored for personal profiles. */
     visibility: "private" | "shared";
-    search_key: string | null;
+    search_key?: string | null;
     /**
      * Storage for arbitrary data that may be used e.g. to track source database/record IDs to relate Envelopes back to
      * internal systems/applications.
      */
-    data: Record<string, any> | null;
+    data?: Record<string, any> | null;
     profile?: IProfile;
     template?: ITemplate | null;
     organization?: IOrganization;
@@ -606,6 +607,8 @@ interface IKbaPINRequired {
     type: "pin";
 }
 interface IRecipient {
+    /** Used only by the Web SDK during builder processes. Not stored in the backend. */
+    id?: string | null;
     envelope_id: string;
     role_name: string;
     profile_id: string;
@@ -685,6 +688,8 @@ interface IReminder {
  * "Unknown" roles are dynamic, and will be filled in later when the envelope is created.
  */
 interface IRole {
+    /** Used only by the Web SDK during builder processes. Not stored in the backend. */
+    id?: string | null;
     template_id: string;
     // The name of the recipient. Note that recipients do not have a separate ID - they are uniquely identified by name.
     name: string;
@@ -1140,7 +1145,7 @@ interface ICreateEnvelopeRecipient {
      * The Role name of the recipient. Please note this is not the person's name. It is the ID of the role, e.g.
      * 'Recipient 1', 'Seller', etc. This must match one of the pre-defined roles in the template's Recipients list.
      */
-    name: string;
+    role_name: string;
     /** The name of the recipient as it will be displayed in reports and queries, e.g. 'Paige Turner'. */
     first_name: string;
     last_name: string;
@@ -1171,6 +1176,22 @@ interface ICreateEnvelopeRecipient {
     kba_method?: "pin" | "identity" | null;
     /** If PIN-based KBA is used, the PIN to challenge the user to enter. */
     kba_pin?: 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.
+    */
+    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;
 }
 interface IInPersonLinkResponse {
     link: string;
@@ -1492,10 +1513,8 @@ declare const envelopeRecipientUpdateName: (endpoint: VerdocsEndpoint, envelopeI
  */
 declare const envelopeRecipientPrepare: (endpoint: VerdocsEndpoint, envelopeId: string, roleName: string, recipients: IRecipient[]) => Promise<IRecipient>;
 interface ISignerTokenResponse {
-    recipient: IRecipient;
     envelope: IEnvelope;
     access_token: string;
-    in_person_key: IInPersonAccessKey;
 }
 /**
  * Get a signing session for an Envelope. Note that this should generally be called with a NON-default