@verdocs/js-sdk 4.2.41 → 4.2.43

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;
@@ -613,6 +614,13 @@ interface IRecipient {
     email: string;
     phone: string | null;
     full_name: string;
+    first_name: string;
+    last_name: string;
+    address: string;
+    city: string;
+    state: string;
+    zip: string;
+    ssn_last_4: string;
     /**
      * The sequence number indicates the order in which Recipients act. Multiple recipients may have the same sequence
      * number, in which case they may act in parallel. (e.g. all Recipients at sequence 2 will receive invites once
@@ -1133,7 +1141,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;
@@ -1164,6 +1172,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;
@@ -1485,10 +1509,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;
@@ -613,6 +614,13 @@ interface IRecipient {
     email: string;
     phone: string | null;
     full_name: string;
+    first_name: string;
+    last_name: string;
+    address: string;
+    city: string;
+    state: string;
+    zip: string;
+    ssn_last_4: string;
     /**
      * The sequence number indicates the order in which Recipients act. Multiple recipients may have the same sequence
      * number, in which case they may act in parallel. (e.g. all Recipients at sequence 2 will receive invites once
@@ -1133,7 +1141,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;
@@ -1164,6 +1172,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;
@@ -1485,10 +1509,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