@verdocs/js-sdk 4.1.6 → 4.1.8

package/dist/index.d.mts

@@ -384,6 +384,9 @@ interface IInitial {
     deleted_at: string | null;
     profile?: IProfile;
 }
+interface IKbaPINRequired {
+    type: "pin";
+}
 interface IRecipient {
     envelope_id: string;
     role_name: string;
@@ -417,10 +420,25 @@ interface IRecipient {
     last_attempt_at: string;
     /**
      * If set, "KBA required" will carry through to automatically enable the same setting in Envelopes
-     * created from this template.
+     * created from this template. For privacy reasons, this field will only be visible to the creator
+     * of the envelope and the recipient referenced.
+     */
+    kba_method: "pin" | "identity" | null;
+    /**
+     * If KBA is set to "PIN" this will be set to the PIN code required. For security reasons, this
+     * field will only be visible to the creator of the envelope.
+     */
+    kba_pin?: string | null;
+    /**
+     * If KBA has been completed successfully, this will be set to true. For privacy reasons, this
+     * field will only be visible to the creator of the envelope and the recipient referenced.
      */
-    kba_method: string | null;
     kba_completed: boolean;
+    /**
+     * If KBA has been completed (or partially successfully, this will contain metadata related to
+     * the questions and answers from the process. For privacy reasons, this field will only be visible
+     * to the recipient referenced.
+     */
     kba_details: Record<string, any>;
     envelope?: IEnvelope;
     profile?: IProfile;
@@ -467,7 +485,7 @@ interface IRole {
      * If set, "KBA required" will carry through to automatically enable the same setting in Envelopes
      * created from this template.
      */
-    kba_method: string | null;
+    kba_method: "pin" | "identity" | null;
 }
 interface ISignature {
     id: string;
@@ -1346,6 +1364,105 @@ declare const getEnvelopesByTemplateId: (endpoint: VerdocsEndpoint, templateId:
  * to be "stamped" by the user.
  */
 declare const createInitials: (endpoint: VerdocsEndpoint, name: string, initials: Blob) => Promise<IInitial>;
+/**
+ * KBA is not required at this time. Note that if there is a discrepancy between the `kba_required`
+ * field here and that in the Recipient object, this object should be considered authoritative
+ * (this can happen if the envelope sender updates the setting after the recipient has already
+ * been invited).
+ */
+interface IRecipientKbaStatusNotRequired {
+    envelope_id: string;
+    role_name: string;
+    kba_required: false;
+}
+/**
+ * KBA has been completed and no further action is required.
+ */
+interface IRecipientKbaStatusComplete {
+    envelope_id: string;
+    role_name: string;
+    kba_required: true;
+    kba_completed: true;
+    kba_method: string;
+}
+/**
+ * A PIN code is required. Prompt the user to enter this PIN, and submit it via `submitKbaPin()`.
+ */
+interface IRecipientKbaStatusPinRequired {
+    envelope_id: string;
+    role_name: string;
+    kba_required: true;
+    kba_completed: false;
+    kba_method: "pin";
+}
+/**
+ * A full identity verification is required. Prompt the user for their address and other (optional)
+ * details and submit them via `submitKbaIdentity()`.
+ */
+interface IRecipientKbaStatusIdentityRequired {
+    envelope_id: string;
+    role_name: string;
+    kba_required: true;
+    kba_completed: false;
+    kba_method: "identity";
+}
+/**
+ * Triggered by full identity verification if additional challenges are required. The recipient
+ * should be shown the message and options, and submit a response via `submitKbaChallengeResponse()`.
+ * Note that this response may be issued more than once if multiple challenges are required.
+ */
+interface IRecipientKbaChallengeRequired {
+    envelope_id: string;
+    role_name: string;
+    kba_required: true;
+    kba_completed: false;
+    kba_method: "challenge";
+    message: string;
+    options: string[];
+}
+/**
+ * Identity verification has failed. The user should be shown the message included. No further
+ * signing operations may be performed.
+ */
+interface IRecipientKbaStatusFailed {
+    envelope_id: string;
+    role_name: string;
+    kba_required: true;
+    kba_completed: false;
+    kba_method: "failed";
+    meesage: string;
+}
+type TRecipientKbaStatus = IRecipientKbaStatusNotRequired | IRecipientKbaStatusComplete | IRecipientKbaStatusPinRequired | IRecipientKbaStatusIdentityRequired | IRecipientKbaChallengeRequired | IRecipientKbaStatusFailed;
+/**
+ * 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
+ * should be called to determine the next KBA step required.
+ */
+declare const getKbaStatus: (endpoint: VerdocsEndpoint, envelopeId: string, roleName: string) => Promise<IRecipientKbaStatusNotRequired | IRecipientKbaStatusComplete | IRecipientKbaStatusPinRequired | IRecipientKbaStatusIdentityRequired | IRecipientKbaChallengeRequired | IRecipientKbaStatusFailed>;
+/**
+ * Submit a response to a KBA PIN challenge.
+ */
+declare const submitKbaPin: (endpoint: VerdocsEndpoint, envelopeId: string, roleName: string, pin: string) => Promise<IRecipientKbaStatusNotRequired | IRecipientKbaStatusComplete | IRecipientKbaStatusPinRequired | IRecipientKbaStatusIdentityRequired | IRecipientKbaChallengeRequired | IRecipientKbaStatusFailed>;
+interface IKbaIdentity {
+    address1: string;
+    address2?: string;
+    city?: string;
+    state?: string;
+    postalCode?: string;
+    country?: string;
+    ssn?: string;
+    ssnLast4?: string;
+}
+/**
+ * Submit an identity response to a KBA challenge.
+ */
+declare const submitKbaIdentity: (endpoint: VerdocsEndpoint, envelopeId: string, roleName: string, identity: IKbaIdentity) => Promise<IRecipientKbaStatusNotRequired | IRecipientKbaStatusComplete | IRecipientKbaStatusPinRequired | IRecipientKbaStatusIdentityRequired | IRecipientKbaChallengeRequired | IRecipientKbaStatusFailed>;
+/**
+ * Submit an identity response to a KBA challenge.
+ */
+declare const submitKbaChallengeResponse: (endpoint: VerdocsEndpoint, envelopeId: string, roleName: string, response: string) => Promise<IRecipientKbaStatusNotRequired | IRecipientKbaStatusComplete | IRecipientKbaStatusPinRequired | IRecipientKbaStatusIdentityRequired | IRecipientKbaChallengeRequired | IRecipientKbaStatusFailed>;
 /**
  * Update a recipient's status block
  */
@@ -1653,6 +1770,26 @@ declare const deleteOrganization: (endpoint: VerdocsEndpoint, organizationId: st
  * Update an organization.
  */
 declare const updateOrganization: (endpoint: VerdocsEndpoint, organizationId: string, params: Partial<IOrganization>) => Promise<IOrganization>;
+/**
+ * Update the organization's logo. This can only be called by an admin or owner of the organization.
+ *
+ * ```typescript
+ * import {uploadOrganizationLogo} from '@verdocs/js-sdk';
+ *
+ * await uploadOrganizationLogo((VerdocsEndpoint.getDefault(), file);
+ * ```
+ */
+declare const uploadOrganizationLogo: (endpoint: VerdocsEndpoint, file: File, onUploadProgress?: (percent: number, loadedBytes: number, totalBytes: number) => void) => Promise<IProfile>;
+/**
+ * Update the organization's thumbnail. This can only be called by an admin or owner of the organization.
+ *
+ * ```typescript
+ * import {uploadOrganizationThumbnail} from '@verdocs/js-sdk';
+ *
+ * await uploadOrganizationThumbnail((VerdocsEndpoint.getDefault(), file);
+ * ```
+ */
+declare const uploadOrganizationThumbnail: (endpoint: VerdocsEndpoint, file: File, onUploadProgress?: (percent: number, loadedBytes: number, totalBytes: number) => void) => Promise<IProfile>;
 /**
  * Get the registered Webhooks for the caller's organization.
  */
@@ -2315,14 +2452,6 @@ declare const isValidEmail: (email: string | undefined) => boolean;
 declare const isValidPhone: (phone: string | undefined) => boolean;
 declare const isValidRoleName: (value: string, roles: IRole[]) => boolean;
 declare const isValidTag: (value: string, tags: string[]) => boolean;
-interface ISwitchProfileResponse {
-    profile: IProfile;
-    accessToken: string;
-    idToken: string;
-    refreshToken: string;
-    accessTokenExp: number;
-    refreshTokenExp: number;
-}
 interface IUpdateProfileRequest {
     first_name?: string;
     last_name?: string;
@@ -2506,7 +2635,7 @@ declare const getProfile: (endpoint: VerdocsEndpoint, profileId: string) => Prom
  * const newProfile = await switchProfile('PROFILEID');
  * ```
  */
-declare const switchProfile: (endpoint: VerdocsEndpoint, profileId: string) => Promise<ISwitchProfileResponse>;
+declare const switchProfile: (endpoint: VerdocsEndpoint, profileId: string) => Promise<IAuthenticateResponse>;
 /**
  * Update a profile. For future expansion, the profile ID to update is required, but currently
  * this must also be the "current" profile for the caller.
@@ -2559,4 +2688,14 @@ declare const createProfile: (endpoint: VerdocsEndpoint, params: ICreateAccountR
     profile: IProfile;
     organization: IOrganization;
 }>;
-export { TRequestStatus, TTemplateSenderType, TTemplatePermission, TTemplateAction, TAccountPermission, TOrgPermission, TApiKeyPermission, TPermission, TRecipientAction, TEnvelopeStatus, TRecipientStatus, TRecipientType, TRole, TSortTemplateBy, TAccessKeyType, THistoryEvent, TEventDetail, TEnvelopeUpdateResult, TFieldType, IChannel, IDisabledChannel, INotification, IApiKey, IGroup, IGroupProfile, IOAuth2App, IOrganization, IOrganizationInvitation, IPendingWebhook, IProfile, IWebhookEvents, IWebhook, IInPersonAccessKey, IInAppAccessKey, IEmailAccessKey, ISMSAccessKey, TAccessKey, IEnvelope, IEnvelopeDocument, IEnvelopeField, IEnvelopeFieldOptions, IEnvelopeFieldSettings, IEnvelopeHistory, IInitial, IRecipient, IReminder, IRole, ISignature, ITemplate, ITemplateDocument, ITemplateField, ITextFieldSetting, ITemplateFieldSetting, IActivityEntry, TEnvironment, TSessionChangedListener, VerdocsEndpointOptions, VerdocsEndpoint, createEnvelope, getEnvelopesSummary, IEnvelopeSearchParams, searchEnvelopes, ISigningSessionResult, getSigningSession, getEnvelopeRecipients, getEnvelope, getEnvelopeDocument, getDocumentDownloadLink, getDocumentPreviewLink, cancelEnvelope, getEnvelopeFile, updateEnvelopeField, updateEnvelopeFieldSignature, updateEnvelopeFieldInitials, uploadEnvelopeFieldAttachment, deleteEnvelopeFieldAttachment, getFieldAttachment, getEnvelopeDocumentPageDisplayUri, throttledGetEnvelope, ITimeRange, IListEnvelopesParams, listEnvelopes, getEnvelopesByTemplateId, createInitials, updateRecipient, envelopeRecipientSubmit, envelopeRecipientDecline, envelopeRecipientChangeOwner, envelopeRecipientAgree, envelopeRecipientUpdateName, envelopeRecipientPrepare, ISignerTokenResponse, getSignerToken, getInPersonLink, sendDelegate, resendInvitation, createEnvelopeReminder, getEnvelopeReminder, updateEnvelopeReminder, deleteEnvelopeReminder, userIsEnvelopeOwner, userIsEnvelopeRecipient, envelopeIsActive, envelopeIsComplete, userCanCancelEnvelope, userCanFinishEnvelope, recipientHasAction, getRecipientsWithActions, recipientCanAct, userCanAct, userCanSignNow, getNextRecipient, createSignature, getSignatures, getSignature, deleteSignature, IEnvelopesSearchResultEntry, IEnvelopesSearchResult, IEnvelopesSummary, IDocumentSearchOptions, ICreateEnvelopeRole, IEnvelopeSummary, IEnvelopeSummaries, IInPersonLinkResponse, IUpdateRecipientSubmitParams, IUpdateRecipientDeclineParams, IUpdateRecipientClaimEnvelope, IUpdateRecipientStatus, IUpdateRecipientAgreedParams, IUpdateRecipientNameParams, IUpdateRecipientPrepareParams, ICreateEnvelopeReminderRequest, ICreateEnvelopeRequest, TEnvelopePermission, getApiKeys, createApiKey, rotateApiKey, updateApiKey, deleteApiKey, getGroups, getGroup, createGroup, addGroupMember, deleteGroupMember, updateGroup, getOrganizationInvitations, createOrganizationInvitation, deleteOrganizationInvitation, updateOrganizationInvitation, resendOrganizationInvitation, getOrganizationInvitation, acceptOrganizationInvitation, declineOrganizationInvitation, getOrganizationMembers, deleteOrganizationMember, updateOrganizationMember, getOrganizations, getOrganization, createOrganization, deleteOrganization, updateOrganization, ICreateApiKeyRequest, IUpdateApiKeyRequest, ICreateInvitationRequest, ISetWebhookRequest, getWebhooks, setWebhooks, userHasPermissions, ISigningSessionRequest, ISigningSession, IUserSession, TSessionType, TSession, TActiveSession, canPerformTemplateAction, hasRequiredPermissions, createField, updateField, deleteField, userIsTemplateCreator, userHasSharedTemplate, userCanCreatePersonalTemplate, userCanCreateOrgTemplate, userCanCreatePublicTemplate, userCanReadTemplate, userCanUpdateTemplate, userCanMakeTemplatePrivate, userCanMakeTemplateShared, userCanMakeTemplatePublic, userCanChangeOrgVisibility, userCanDeleteTemplate, userCanSendTemplate, userCanCreateTemplate, userCanBuildTemplate, getFieldsForRole, userCanPreviewTemplate, ICreateTemplateReminderRequest, createTemplateReminder, getTemplateReminder, updateTemplateReminder, deleteTemplateReminder, createTemplateRole, getTemplateRoles, getTemplateRole, updateTemplateRole, deleteTemplateRole, getTemplateRoleFields, getStars, toggleStar, addTemplateTag, getTemplateTags, deleteTemplateTag, createTag, getTag, getAllTags, IGetTemplatesParams, getTemplates, getTemplate, getTemplateOwnerInfo, IDocumentFromUri, IDocumentFromData, ITemplateCreateParams, createTemplate, createTemplatev2, ITemplateCreateFromSharepointParams, createTemplateFromSharepoint, updateTemplate, deleteTemplate, searchTemplates, ISearchTimeRange, IGetTemplateSummarySortBy, IGetTemplateSummaryParams, getTemplatesSummary, throttledGetTemplate, ITemplateListParams, listTemplates, getTemplateDocuments, getTemplateDocument, createTemplateDocument, deleteTemplateDocument, getTemplateDocumentFile, getTemplateDocumentThumbnail, getTemplateDocumentPageDisplayUri, ITemplateSummary, ITemplateSearchParams, ITemplateSummaries, ITemplateTag, ITag, IStar, ITemplateOwnerInfo, ITemplateSearchResult, IValidator, getValidators, getValidator, isValidEmail, isValidPhone, isValidRoleName, isValidTag, IROPCRequest, IClientCredentialsRequest, IRefreshTokenRequest, TAuthenticationRequest, authenticate, refreshToken, changePassword, resetPassword, verifyEmail, resendVerification, getNotifications, getProfiles, getCurrentProfile, getProfile, switchProfile, updateProfile, deleteProfile, createProfile, ISwitchProfileResponse, IUpdateProfileRequest, IAuthenticateResponse, IUpdatePasswordRequest, IUpdatePasswordResponse, ICreateAccountRequest, getRGB, getRGBA, nameToRGBA, getRoleColor, formatShortTimeAgo, timePeriod, getRTop, getRLeft, getRValue, blobToBase64, rescale, fileToDataUrl, downloadBlob, Countries, getCountryByCode, isFrenchGuiana, isGuadeloupe, isMartinique, isMayotte, getPlusOneCountry, isCanada, isAmericanSamoa, isDominicanRepublic, isPuertoRico, getMatchingCountry, integerSequence, formatFullName, formatInitials, fullNameToInitials, capitalize, convertToE164, AtoB, decodeJWTBody, decodeAccessTokenBody, IFileWithData, ICountry, ITimePeriod };
+/**
+ * Update the caller's profile photo. This can only be called for the user's "current" profile.
+ *
+ * ```typescript
+ * import {uploadProfilePhoto} from '@verdocs/js-sdk';
+ *
+ * await uploadProfilePhoto((VerdocsEndpoint.getDefault(), file);
+ * ```
+ */
+declare const uploadProfilePhoto: (endpoint: VerdocsEndpoint, file: File, onUploadProgress?: (percent: number, loadedBytes: number, totalBytes: number) => void) => Promise<IProfile>;
+export { TRequestStatus, TTemplateSenderType, TTemplatePermission, TTemplateAction, TAccountPermission, TOrgPermission, TApiKeyPermission, TPermission, TRecipientAction, TEnvelopeStatus, TRecipientStatus, TRecipientType, TRole, TSortTemplateBy, TAccessKeyType, THistoryEvent, TEventDetail, TEnvelopeUpdateResult, TFieldType, IChannel, IDisabledChannel, INotification, IApiKey, IGroup, IGroupProfile, IOAuth2App, IOrganization, IOrganizationInvitation, IPendingWebhook, IProfile, IWebhookEvents, IWebhook, IInPersonAccessKey, IInAppAccessKey, IEmailAccessKey, ISMSAccessKey, TAccessKey, IEnvelope, IEnvelopeDocument, IEnvelopeField, IEnvelopeFieldOptions, IEnvelopeFieldSettings, IEnvelopeHistory, IInitial, IKbaPINRequired, IRecipient, IReminder, IRole, ISignature, ITemplate, ITemplateDocument, ITemplateField, ITextFieldSetting, ITemplateFieldSetting, IActivityEntry, TEnvironment, TSessionChangedListener, VerdocsEndpointOptions, VerdocsEndpoint, createEnvelope, getEnvelopesSummary, IEnvelopeSearchParams, searchEnvelopes, ISigningSessionResult, getSigningSession, getEnvelopeRecipients, getEnvelope, getEnvelopeDocument, getDocumentDownloadLink, getDocumentPreviewLink, cancelEnvelope, getEnvelopeFile, updateEnvelopeField, updateEnvelopeFieldSignature, updateEnvelopeFieldInitials, uploadEnvelopeFieldAttachment, deleteEnvelopeFieldAttachment, getFieldAttachment, getEnvelopeDocumentPageDisplayUri, throttledGetEnvelope, ITimeRange, IListEnvelopesParams, listEnvelopes, getEnvelopesByTemplateId, createInitials, IRecipientKbaStatusNotRequired, IRecipientKbaStatusComplete, IRecipientKbaStatusPinRequired, IRecipientKbaStatusIdentityRequired, IRecipientKbaChallengeRequired, IRecipientKbaStatusFailed, TRecipientKbaStatus, getKbaStatus, submitKbaPin, IKbaIdentity, submitKbaIdentity, submitKbaChallengeResponse, updateRecipient, envelopeRecipientSubmit, envelopeRecipientDecline, envelopeRecipientChangeOwner, envelopeRecipientAgree, envelopeRecipientUpdateName, envelopeRecipientPrepare, ISignerTokenResponse, getSignerToken, getInPersonLink, sendDelegate, resendInvitation, createEnvelopeReminder, getEnvelopeReminder, updateEnvelopeReminder, deleteEnvelopeReminder, userIsEnvelopeOwner, userIsEnvelopeRecipient, envelopeIsActive, envelopeIsComplete, userCanCancelEnvelope, userCanFinishEnvelope, recipientHasAction, getRecipientsWithActions, recipientCanAct, userCanAct, userCanSignNow, getNextRecipient, createSignature, getSignatures, getSignature, deleteSignature, IEnvelopesSearchResultEntry, IEnvelopesSearchResult, IEnvelopesSummary, IDocumentSearchOptions, ICreateEnvelopeRole, IEnvelopeSummary, IEnvelopeSummaries, IInPersonLinkResponse, IUpdateRecipientSubmitParams, IUpdateRecipientDeclineParams, IUpdateRecipientClaimEnvelope, IUpdateRecipientStatus, IUpdateRecipientAgreedParams, IUpdateRecipientNameParams, IUpdateRecipientPrepareParams, ICreateEnvelopeReminderRequest, ICreateEnvelopeRequest, TEnvelopePermission, getApiKeys, createApiKey, rotateApiKey, updateApiKey, deleteApiKey, getGroups, getGroup, createGroup, addGroupMember, deleteGroupMember, updateGroup, getOrganizationInvitations, createOrganizationInvitation, deleteOrganizationInvitation, updateOrganizationInvitation, resendOrganizationInvitation, getOrganizationInvitation, acceptOrganizationInvitation, declineOrganizationInvitation, getOrganizationMembers, deleteOrganizationMember, updateOrganizationMember, getOrganizations, getOrganization, createOrganization, deleteOrganization, updateOrganization, uploadOrganizationLogo, uploadOrganizationThumbnail, ICreateApiKeyRequest, IUpdateApiKeyRequest, ICreateInvitationRequest, ISetWebhookRequest, getWebhooks, setWebhooks, userHasPermissions, ISigningSessionRequest, ISigningSession, IUserSession, TSessionType, TSession, TActiveSession, canPerformTemplateAction, hasRequiredPermissions, createField, updateField, deleteField, userIsTemplateCreator, userHasSharedTemplate, userCanCreatePersonalTemplate, userCanCreateOrgTemplate, userCanCreatePublicTemplate, userCanReadTemplate, userCanUpdateTemplate, userCanMakeTemplatePrivate, userCanMakeTemplateShared, userCanMakeTemplatePublic, userCanChangeOrgVisibility, userCanDeleteTemplate, userCanSendTemplate, userCanCreateTemplate, userCanBuildTemplate, getFieldsForRole, userCanPreviewTemplate, ICreateTemplateReminderRequest, createTemplateReminder, getTemplateReminder, updateTemplateReminder, deleteTemplateReminder, createTemplateRole, getTemplateRoles, getTemplateRole, updateTemplateRole, deleteTemplateRole, getTemplateRoleFields, getStars, toggleStar, addTemplateTag, getTemplateTags, deleteTemplateTag, createTag, getTag, getAllTags, IGetTemplatesParams, getTemplates, getTemplate, getTemplateOwnerInfo, IDocumentFromUri, IDocumentFromData, ITemplateCreateParams, createTemplate, createTemplatev2, ITemplateCreateFromSharepointParams, createTemplateFromSharepoint, updateTemplate, deleteTemplate, searchTemplates, ISearchTimeRange, IGetTemplateSummarySortBy, IGetTemplateSummaryParams, getTemplatesSummary, throttledGetTemplate, ITemplateListParams, listTemplates, getTemplateDocuments, getTemplateDocument, createTemplateDocument, deleteTemplateDocument, getTemplateDocumentFile, getTemplateDocumentThumbnail, getTemplateDocumentPageDisplayUri, ITemplateSummary, ITemplateSearchParams, ITemplateSummaries, ITemplateTag, ITag, IStar, ITemplateOwnerInfo, ITemplateSearchResult, IValidator, getValidators, getValidator, isValidEmail, isValidPhone, isValidRoleName, isValidTag, IROPCRequest, IClientCredentialsRequest, IRefreshTokenRequest, TAuthenticationRequest, authenticate, refreshToken, changePassword, resetPassword, verifyEmail, resendVerification, getNotifications, getProfiles, getCurrentProfile, getProfile, switchProfile, updateProfile, deleteProfile, createProfile, uploadProfilePhoto, IUpdateProfileRequest, IAuthenticateResponse, IUpdatePasswordRequest, IUpdatePasswordResponse, ICreateAccountRequest, getRGB, getRGBA, nameToRGBA, getRoleColor, formatShortTimeAgo, timePeriod, getRTop, getRLeft, getRValue, blobToBase64, rescale, fileToDataUrl, downloadBlob, Countries, getCountryByCode, isFrenchGuiana, isGuadeloupe, isMartinique, isMayotte, getPlusOneCountry, isCanada, isAmericanSamoa, isDominicanRepublic, isPuertoRico, getMatchingCountry, integerSequence, formatFullName, formatInitials, fullNameToInitials, capitalize, convertToE164, AtoB, decodeJWTBody, decodeAccessTokenBody, IFileWithData, ICountry, ITimePeriod };

package/dist/index.d.ts

@@ -384,6 +384,9 @@ interface IInitial {
     deleted_at: string | null;
     profile?: IProfile;
 }
+interface IKbaPINRequired {
+    type: "pin";
+}
 interface IRecipient {
     envelope_id: string;
     role_name: string;
@@ -417,10 +420,25 @@ interface IRecipient {
     last_attempt_at: string;
     /**
      * If set, "KBA required" will carry through to automatically enable the same setting in Envelopes
-     * created from this template.
+     * created from this template. For privacy reasons, this field will only be visible to the creator
+     * of the envelope and the recipient referenced.
+     */
+    kba_method: "pin" | "identity" | null;
+    /**
+     * If KBA is set to "PIN" this will be set to the PIN code required. For security reasons, this
+     * field will only be visible to the creator of the envelope.
+     */
+    kba_pin?: string | null;
+    /**
+     * If KBA has been completed successfully, this will be set to true. For privacy reasons, this
+     * field will only be visible to the creator of the envelope and the recipient referenced.
      */
-    kba_method: string | null;
     kba_completed: boolean;
+    /**
+     * If KBA has been completed (or partially successfully, this will contain metadata related to
+     * the questions and answers from the process. For privacy reasons, this field will only be visible
+     * to the recipient referenced.
+     */
     kba_details: Record<string, any>;
     envelope?: IEnvelope;
     profile?: IProfile;
@@ -467,7 +485,7 @@ interface IRole {
      * If set, "KBA required" will carry through to automatically enable the same setting in Envelopes
      * created from this template.
      */
-    kba_method: string | null;
+    kba_method: "pin" | "identity" | null;
 }
 interface ISignature {
     id: string;
@@ -1346,6 +1364,105 @@ declare const getEnvelopesByTemplateId: (endpoint: VerdocsEndpoint, templateId:
  * to be "stamped" by the user.
  */
 declare const createInitials: (endpoint: VerdocsEndpoint, name: string, initials: Blob) => Promise<IInitial>;
+/**
+ * KBA is not required at this time. Note that if there is a discrepancy between the `kba_required`
+ * field here and that in the Recipient object, this object should be considered authoritative
+ * (this can happen if the envelope sender updates the setting after the recipient has already
+ * been invited).
+ */
+interface IRecipientKbaStatusNotRequired {
+    envelope_id: string;
+    role_name: string;
+    kba_required: false;
+}
+/**
+ * KBA has been completed and no further action is required.
+ */
+interface IRecipientKbaStatusComplete {
+    envelope_id: string;
+    role_name: string;
+    kba_required: true;
+    kba_completed: true;
+    kba_method: string;
+}
+/**
+ * A PIN code is required. Prompt the user to enter this PIN, and submit it via `submitKbaPin()`.
+ */
+interface IRecipientKbaStatusPinRequired {
+    envelope_id: string;
+    role_name: string;
+    kba_required: true;
+    kba_completed: false;
+    kba_method: "pin";
+}
+/**
+ * A full identity verification is required. Prompt the user for their address and other (optional)
+ * details and submit them via `submitKbaIdentity()`.
+ */
+interface IRecipientKbaStatusIdentityRequired {
+    envelope_id: string;
+    role_name: string;
+    kba_required: true;
+    kba_completed: false;
+    kba_method: "identity";
+}
+/**
+ * Triggered by full identity verification if additional challenges are required. The recipient
+ * should be shown the message and options, and submit a response via `submitKbaChallengeResponse()`.
+ * Note that this response may be issued more than once if multiple challenges are required.
+ */
+interface IRecipientKbaChallengeRequired {
+    envelope_id: string;
+    role_name: string;
+    kba_required: true;
+    kba_completed: false;
+    kba_method: "challenge";
+    message: string;
+    options: string[];
+}
+/**
+ * Identity verification has failed. The user should be shown the message included. No further
+ * signing operations may be performed.
+ */
+interface IRecipientKbaStatusFailed {
+    envelope_id: string;
+    role_name: string;
+    kba_required: true;
+    kba_completed: false;
+    kba_method: "failed";
+    meesage: string;
+}
+type TRecipientKbaStatus = IRecipientKbaStatusNotRequired | IRecipientKbaStatusComplete | IRecipientKbaStatusPinRequired | IRecipientKbaStatusIdentityRequired | IRecipientKbaChallengeRequired | IRecipientKbaStatusFailed;
+/**
+ * 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
+ * should be called to determine the next KBA step required.
+ */
+declare const getKbaStatus: (endpoint: VerdocsEndpoint, envelopeId: string, roleName: string) => Promise<IRecipientKbaStatusNotRequired | IRecipientKbaStatusComplete | IRecipientKbaStatusPinRequired | IRecipientKbaStatusIdentityRequired | IRecipientKbaChallengeRequired | IRecipientKbaStatusFailed>;
+/**
+ * Submit a response to a KBA PIN challenge.
+ */
+declare const submitKbaPin: (endpoint: VerdocsEndpoint, envelopeId: string, roleName: string, pin: string) => Promise<IRecipientKbaStatusNotRequired | IRecipientKbaStatusComplete | IRecipientKbaStatusPinRequired | IRecipientKbaStatusIdentityRequired | IRecipientKbaChallengeRequired | IRecipientKbaStatusFailed>;
+interface IKbaIdentity {
+    address1: string;
+    address2?: string;
+    city?: string;
+    state?: string;
+    postalCode?: string;
+    country?: string;
+    ssn?: string;
+    ssnLast4?: string;
+}
+/**
+ * Submit an identity response to a KBA challenge.
+ */
+declare const submitKbaIdentity: (endpoint: VerdocsEndpoint, envelopeId: string, roleName: string, identity: IKbaIdentity) => Promise<IRecipientKbaStatusNotRequired | IRecipientKbaStatusComplete | IRecipientKbaStatusPinRequired | IRecipientKbaStatusIdentityRequired | IRecipientKbaChallengeRequired | IRecipientKbaStatusFailed>;
+/**
+ * Submit an identity response to a KBA challenge.
+ */
+declare const submitKbaChallengeResponse: (endpoint: VerdocsEndpoint, envelopeId: string, roleName: string, response: string) => Promise<IRecipientKbaStatusNotRequired | IRecipientKbaStatusComplete | IRecipientKbaStatusPinRequired | IRecipientKbaStatusIdentityRequired | IRecipientKbaChallengeRequired | IRecipientKbaStatusFailed>;
 /**
  * Update a recipient's status block
  */
@@ -1653,6 +1770,26 @@ declare const deleteOrganization: (endpoint: VerdocsEndpoint, organizationId: st
  * Update an organization.
  */
 declare const updateOrganization: (endpoint: VerdocsEndpoint, organizationId: string, params: Partial<IOrganization>) => Promise<IOrganization>;
+/**
+ * Update the organization's logo. This can only be called by an admin or owner of the organization.
+ *
+ * ```typescript
+ * import {uploadOrganizationLogo} from '@verdocs/js-sdk';
+ *
+ * await uploadOrganizationLogo((VerdocsEndpoint.getDefault(), file);
+ * ```
+ */
+declare const uploadOrganizationLogo: (endpoint: VerdocsEndpoint, file: File, onUploadProgress?: (percent: number, loadedBytes: number, totalBytes: number) => void) => Promise<IProfile>;
+/**
+ * Update the organization's thumbnail. This can only be called by an admin or owner of the organization.
+ *
+ * ```typescript
+ * import {uploadOrganizationThumbnail} from '@verdocs/js-sdk';
+ *
+ * await uploadOrganizationThumbnail((VerdocsEndpoint.getDefault(), file);
+ * ```
+ */
+declare const uploadOrganizationThumbnail: (endpoint: VerdocsEndpoint, file: File, onUploadProgress?: (percent: number, loadedBytes: number, totalBytes: number) => void) => Promise<IProfile>;
 /**
  * Get the registered Webhooks for the caller's organization.
  */
@@ -2315,14 +2452,6 @@ declare const isValidEmail: (email: string | undefined) => boolean;
 declare const isValidPhone: (phone: string | undefined) => boolean;
 declare const isValidRoleName: (value: string, roles: IRole[]) => boolean;
 declare const isValidTag: (value: string, tags: string[]) => boolean;
-interface ISwitchProfileResponse {
-    profile: IProfile;
-    accessToken: string;
-    idToken: string;
-    refreshToken: string;
-    accessTokenExp: number;
-    refreshTokenExp: number;
-}
 interface IUpdateProfileRequest {
     first_name?: string;
     last_name?: string;
@@ -2506,7 +2635,7 @@ declare const getProfile: (endpoint: VerdocsEndpoint, profileId: string) => Prom
  * const newProfile = await switchProfile('PROFILEID');
  * ```
  */
-declare const switchProfile: (endpoint: VerdocsEndpoint, profileId: string) => Promise<ISwitchProfileResponse>;
+declare const switchProfile: (endpoint: VerdocsEndpoint, profileId: string) => Promise<IAuthenticateResponse>;
 /**
  * Update a profile. For future expansion, the profile ID to update is required, but currently
  * this must also be the "current" profile for the caller.
@@ -2559,4 +2688,14 @@ declare const createProfile: (endpoint: VerdocsEndpoint, params: ICreateAccountR
     profile: IProfile;
     organization: IOrganization;
 }>;
-export { TRequestStatus, TTemplateSenderType, TTemplatePermission, TTemplateAction, TAccountPermission, TOrgPermission, TApiKeyPermission, TPermission, TRecipientAction, TEnvelopeStatus, TRecipientStatus, TRecipientType, TRole, TSortTemplateBy, TAccessKeyType, THistoryEvent, TEventDetail, TEnvelopeUpdateResult, TFieldType, IChannel, IDisabledChannel, INotification, IApiKey, IGroup, IGroupProfile, IOAuth2App, IOrganization, IOrganizationInvitation, IPendingWebhook, IProfile, IWebhookEvents, IWebhook, IInPersonAccessKey, IInAppAccessKey, IEmailAccessKey, ISMSAccessKey, TAccessKey, IEnvelope, IEnvelopeDocument, IEnvelopeField, IEnvelopeFieldOptions, IEnvelopeFieldSettings, IEnvelopeHistory, IInitial, IRecipient, IReminder, IRole, ISignature, ITemplate, ITemplateDocument, ITemplateField, ITextFieldSetting, ITemplateFieldSetting, IActivityEntry, TEnvironment, TSessionChangedListener, VerdocsEndpointOptions, VerdocsEndpoint, createEnvelope, getEnvelopesSummary, IEnvelopeSearchParams, searchEnvelopes, ISigningSessionResult, getSigningSession, getEnvelopeRecipients, getEnvelope, getEnvelopeDocument, getDocumentDownloadLink, getDocumentPreviewLink, cancelEnvelope, getEnvelopeFile, updateEnvelopeField, updateEnvelopeFieldSignature, updateEnvelopeFieldInitials, uploadEnvelopeFieldAttachment, deleteEnvelopeFieldAttachment, getFieldAttachment, getEnvelopeDocumentPageDisplayUri, throttledGetEnvelope, ITimeRange, IListEnvelopesParams, listEnvelopes, getEnvelopesByTemplateId, createInitials, updateRecipient, envelopeRecipientSubmit, envelopeRecipientDecline, envelopeRecipientChangeOwner, envelopeRecipientAgree, envelopeRecipientUpdateName, envelopeRecipientPrepare, ISignerTokenResponse, getSignerToken, getInPersonLink, sendDelegate, resendInvitation, createEnvelopeReminder, getEnvelopeReminder, updateEnvelopeReminder, deleteEnvelopeReminder, userIsEnvelopeOwner, userIsEnvelopeRecipient, envelopeIsActive, envelopeIsComplete, userCanCancelEnvelope, userCanFinishEnvelope, recipientHasAction, getRecipientsWithActions, recipientCanAct, userCanAct, userCanSignNow, getNextRecipient, createSignature, getSignatures, getSignature, deleteSignature, IEnvelopesSearchResultEntry, IEnvelopesSearchResult, IEnvelopesSummary, IDocumentSearchOptions, ICreateEnvelopeRole, IEnvelopeSummary, IEnvelopeSummaries, IInPersonLinkResponse, IUpdateRecipientSubmitParams, IUpdateRecipientDeclineParams, IUpdateRecipientClaimEnvelope, IUpdateRecipientStatus, IUpdateRecipientAgreedParams, IUpdateRecipientNameParams, IUpdateRecipientPrepareParams, ICreateEnvelopeReminderRequest, ICreateEnvelopeRequest, TEnvelopePermission, getApiKeys, createApiKey, rotateApiKey, updateApiKey, deleteApiKey, getGroups, getGroup, createGroup, addGroupMember, deleteGroupMember, updateGroup, getOrganizationInvitations, createOrganizationInvitation, deleteOrganizationInvitation, updateOrganizationInvitation, resendOrganizationInvitation, getOrganizationInvitation, acceptOrganizationInvitation, declineOrganizationInvitation, getOrganizationMembers, deleteOrganizationMember, updateOrganizationMember, getOrganizations, getOrganization, createOrganization, deleteOrganization, updateOrganization, ICreateApiKeyRequest, IUpdateApiKeyRequest, ICreateInvitationRequest, ISetWebhookRequest, getWebhooks, setWebhooks, userHasPermissions, ISigningSessionRequest, ISigningSession, IUserSession, TSessionType, TSession, TActiveSession, canPerformTemplateAction, hasRequiredPermissions, createField, updateField, deleteField, userIsTemplateCreator, userHasSharedTemplate, userCanCreatePersonalTemplate, userCanCreateOrgTemplate, userCanCreatePublicTemplate, userCanReadTemplate, userCanUpdateTemplate, userCanMakeTemplatePrivate, userCanMakeTemplateShared, userCanMakeTemplatePublic, userCanChangeOrgVisibility, userCanDeleteTemplate, userCanSendTemplate, userCanCreateTemplate, userCanBuildTemplate, getFieldsForRole, userCanPreviewTemplate, ICreateTemplateReminderRequest, createTemplateReminder, getTemplateReminder, updateTemplateReminder, deleteTemplateReminder, createTemplateRole, getTemplateRoles, getTemplateRole, updateTemplateRole, deleteTemplateRole, getTemplateRoleFields, getStars, toggleStar, addTemplateTag, getTemplateTags, deleteTemplateTag, createTag, getTag, getAllTags, IGetTemplatesParams, getTemplates, getTemplate, getTemplateOwnerInfo, IDocumentFromUri, IDocumentFromData, ITemplateCreateParams, createTemplate, createTemplatev2, ITemplateCreateFromSharepointParams, createTemplateFromSharepoint, updateTemplate, deleteTemplate, searchTemplates, ISearchTimeRange, IGetTemplateSummarySortBy, IGetTemplateSummaryParams, getTemplatesSummary, throttledGetTemplate, ITemplateListParams, listTemplates, getTemplateDocuments, getTemplateDocument, createTemplateDocument, deleteTemplateDocument, getTemplateDocumentFile, getTemplateDocumentThumbnail, getTemplateDocumentPageDisplayUri, ITemplateSummary, ITemplateSearchParams, ITemplateSummaries, ITemplateTag, ITag, IStar, ITemplateOwnerInfo, ITemplateSearchResult, IValidator, getValidators, getValidator, isValidEmail, isValidPhone, isValidRoleName, isValidTag, IROPCRequest, IClientCredentialsRequest, IRefreshTokenRequest, TAuthenticationRequest, authenticate, refreshToken, changePassword, resetPassword, verifyEmail, resendVerification, getNotifications, getProfiles, getCurrentProfile, getProfile, switchProfile, updateProfile, deleteProfile, createProfile, ISwitchProfileResponse, IUpdateProfileRequest, IAuthenticateResponse, IUpdatePasswordRequest, IUpdatePasswordResponse, ICreateAccountRequest, getRGB, getRGBA, nameToRGBA, getRoleColor, formatShortTimeAgo, timePeriod, getRTop, getRLeft, getRValue, blobToBase64, rescale, fileToDataUrl, downloadBlob, Countries, getCountryByCode, isFrenchGuiana, isGuadeloupe, isMartinique, isMayotte, getPlusOneCountry, isCanada, isAmericanSamoa, isDominicanRepublic, isPuertoRico, getMatchingCountry, integerSequence, formatFullName, formatInitials, fullNameToInitials, capitalize, convertToE164, AtoB, decodeJWTBody, decodeAccessTokenBody, IFileWithData, ICountry, ITimePeriod };
+/**
+ * Update the caller's profile photo. This can only be called for the user's "current" profile.
+ *
+ * ```typescript
+ * import {uploadProfilePhoto} from '@verdocs/js-sdk';
+ *
+ * await uploadProfilePhoto((VerdocsEndpoint.getDefault(), file);
+ * ```
+ */
+declare const uploadProfilePhoto: (endpoint: VerdocsEndpoint, file: File, onUploadProgress?: (percent: number, loadedBytes: number, totalBytes: number) => void) => Promise<IProfile>;
+export { TRequestStatus, TTemplateSenderType, TTemplatePermission, TTemplateAction, TAccountPermission, TOrgPermission, TApiKeyPermission, TPermission, TRecipientAction, TEnvelopeStatus, TRecipientStatus, TRecipientType, TRole, TSortTemplateBy, TAccessKeyType, THistoryEvent, TEventDetail, TEnvelopeUpdateResult, TFieldType, IChannel, IDisabledChannel, INotification, IApiKey, IGroup, IGroupProfile, IOAuth2App, IOrganization, IOrganizationInvitation, IPendingWebhook, IProfile, IWebhookEvents, IWebhook, IInPersonAccessKey, IInAppAccessKey, IEmailAccessKey, ISMSAccessKey, TAccessKey, IEnvelope, IEnvelopeDocument, IEnvelopeField, IEnvelopeFieldOptions, IEnvelopeFieldSettings, IEnvelopeHistory, IInitial, IKbaPINRequired, IRecipient, IReminder, IRole, ISignature, ITemplate, ITemplateDocument, ITemplateField, ITextFieldSetting, ITemplateFieldSetting, IActivityEntry, TEnvironment, TSessionChangedListener, VerdocsEndpointOptions, VerdocsEndpoint, createEnvelope, getEnvelopesSummary, IEnvelopeSearchParams, searchEnvelopes, ISigningSessionResult, getSigningSession, getEnvelopeRecipients, getEnvelope, getEnvelopeDocument, getDocumentDownloadLink, getDocumentPreviewLink, cancelEnvelope, getEnvelopeFile, updateEnvelopeField, updateEnvelopeFieldSignature, updateEnvelopeFieldInitials, uploadEnvelopeFieldAttachment, deleteEnvelopeFieldAttachment, getFieldAttachment, getEnvelopeDocumentPageDisplayUri, throttledGetEnvelope, ITimeRange, IListEnvelopesParams, listEnvelopes, getEnvelopesByTemplateId, createInitials, IRecipientKbaStatusNotRequired, IRecipientKbaStatusComplete, IRecipientKbaStatusPinRequired, IRecipientKbaStatusIdentityRequired, IRecipientKbaChallengeRequired, IRecipientKbaStatusFailed, TRecipientKbaStatus, getKbaStatus, submitKbaPin, IKbaIdentity, submitKbaIdentity, submitKbaChallengeResponse, updateRecipient, envelopeRecipientSubmit, envelopeRecipientDecline, envelopeRecipientChangeOwner, envelopeRecipientAgree, envelopeRecipientUpdateName, envelopeRecipientPrepare, ISignerTokenResponse, getSignerToken, getInPersonLink, sendDelegate, resendInvitation, createEnvelopeReminder, getEnvelopeReminder, updateEnvelopeReminder, deleteEnvelopeReminder, userIsEnvelopeOwner, userIsEnvelopeRecipient, envelopeIsActive, envelopeIsComplete, userCanCancelEnvelope, userCanFinishEnvelope, recipientHasAction, getRecipientsWithActions, recipientCanAct, userCanAct, userCanSignNow, getNextRecipient, createSignature, getSignatures, getSignature, deleteSignature, IEnvelopesSearchResultEntry, IEnvelopesSearchResult, IEnvelopesSummary, IDocumentSearchOptions, ICreateEnvelopeRole, IEnvelopeSummary, IEnvelopeSummaries, IInPersonLinkResponse, IUpdateRecipientSubmitParams, IUpdateRecipientDeclineParams, IUpdateRecipientClaimEnvelope, IUpdateRecipientStatus, IUpdateRecipientAgreedParams, IUpdateRecipientNameParams, IUpdateRecipientPrepareParams, ICreateEnvelopeReminderRequest, ICreateEnvelopeRequest, TEnvelopePermission, getApiKeys, createApiKey, rotateApiKey, updateApiKey, deleteApiKey, getGroups, getGroup, createGroup, addGroupMember, deleteGroupMember, updateGroup, getOrganizationInvitations, createOrganizationInvitation, deleteOrganizationInvitation, updateOrganizationInvitation, resendOrganizationInvitation, getOrganizationInvitation, acceptOrganizationInvitation, declineOrganizationInvitation, getOrganizationMembers, deleteOrganizationMember, updateOrganizationMember, getOrganizations, getOrganization, createOrganization, deleteOrganization, updateOrganization, uploadOrganizationLogo, uploadOrganizationThumbnail, ICreateApiKeyRequest, IUpdateApiKeyRequest, ICreateInvitationRequest, ISetWebhookRequest, getWebhooks, setWebhooks, userHasPermissions, ISigningSessionRequest, ISigningSession, IUserSession, TSessionType, TSession, TActiveSession, canPerformTemplateAction, hasRequiredPermissions, createField, updateField, deleteField, userIsTemplateCreator, userHasSharedTemplate, userCanCreatePersonalTemplate, userCanCreateOrgTemplate, userCanCreatePublicTemplate, userCanReadTemplate, userCanUpdateTemplate, userCanMakeTemplatePrivate, userCanMakeTemplateShared, userCanMakeTemplatePublic, userCanChangeOrgVisibility, userCanDeleteTemplate, userCanSendTemplate, userCanCreateTemplate, userCanBuildTemplate, getFieldsForRole, userCanPreviewTemplate, ICreateTemplateReminderRequest, createTemplateReminder, getTemplateReminder, updateTemplateReminder, deleteTemplateReminder, createTemplateRole, getTemplateRoles, getTemplateRole, updateTemplateRole, deleteTemplateRole, getTemplateRoleFields, getStars, toggleStar, addTemplateTag, getTemplateTags, deleteTemplateTag, createTag, getTag, getAllTags, IGetTemplatesParams, getTemplates, getTemplate, getTemplateOwnerInfo, IDocumentFromUri, IDocumentFromData, ITemplateCreateParams, createTemplate, createTemplatev2, ITemplateCreateFromSharepointParams, createTemplateFromSharepoint, updateTemplate, deleteTemplate, searchTemplates, ISearchTimeRange, IGetTemplateSummarySortBy, IGetTemplateSummaryParams, getTemplatesSummary, throttledGetTemplate, ITemplateListParams, listTemplates, getTemplateDocuments, getTemplateDocument, createTemplateDocument, deleteTemplateDocument, getTemplateDocumentFile, getTemplateDocumentThumbnail, getTemplateDocumentPageDisplayUri, ITemplateSummary, ITemplateSearchParams, ITemplateSummaries, ITemplateTag, ITag, IStar, ITemplateOwnerInfo, ITemplateSearchResult, IValidator, getValidators, getValidator, isValidEmail, isValidPhone, isValidRoleName, isValidTag, IROPCRequest, IClientCredentialsRequest, IRefreshTokenRequest, TAuthenticationRequest, authenticate, refreshToken, changePassword, resetPassword, verifyEmail, resendVerification, getNotifications, getProfiles, getCurrentProfile, getProfile, switchProfile, updateProfile, deleteProfile, createProfile, uploadProfilePhoto, IUpdateProfileRequest, IAuthenticateResponse, IUpdatePasswordRequest, IUpdatePasswordResponse, ICreateAccountRequest, getRGB, getRGBA, nameToRGBA, getRoleColor, formatShortTimeAgo, timePeriod, getRTop, getRLeft, getRValue, blobToBase64, rescale, fileToDataUrl, downloadBlob, Countries, getCountryByCode, isFrenchGuiana, isGuadeloupe, isMartinique, isMayotte, getPlusOneCountry, isCanada, isAmericanSamoa, isDominicanRepublic, isPuertoRico, getMatchingCountry, integerSequence, formatFullName, formatInitials, fullNameToInitials, capitalize, convertToE164, AtoB, decodeJWTBody, decodeAccessTokenBody, IFileWithData, ICountry, ITimePeriod };

package/dist/index.js

@@ -1385,6 +1385,35 @@ const createInitials = (endpoint, name, initials) => {
         .then((r) => r.data);
 };
 
+/**
+ * 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
+ * should be called to determine the next KBA step required.
+ */
+const getKbaStatus = (endpoint, envelopeId, roleName) => endpoint.api //
+    .get(`/v2/kba/${envelopeId}/${encodeURIComponent(roleName)}`)
+    .then((r) => r.data);
+/**
+ * Submit a response to a KBA PIN challenge.
+ */
+const submitKbaPin = (endpoint, envelopeId, roleName, pin) => endpoint.api //
+    .post(`/v2/kba/pin`, { envelopeId, roleName, pin })
+    .then((r) => r.data);
+/**
+ * Submit an identity response to a KBA challenge.
+ */
+const submitKbaIdentity = (endpoint, envelopeId, roleName, identity) => endpoint.api //
+    .post(`/v2/kba/identity`, { envelopeId, roleName, identity })
+    .then((r) => r.data);
+/**
+ * Submit an identity response to a KBA challenge.
+ */
+const submitKbaChallengeResponse = (endpoint, envelopeId, roleName, response) => endpoint.api //
+    .post(`/v2/kba/response`, { envelopeId, roleName, response })
+    .then((r) => r.data);
+
 /**
  * Update a recipient's status block
  */
@@ -1770,6 +1799,52 @@ const deleteOrganization = (endpoint, organizationId) => endpoint.api //
 const updateOrganization = (endpoint, organizationId, params) => endpoint.api //
     .patch(`/v2/organizations/${organizationId}`, params)
     .then((r) => r.data);
+/**
+ * Update the organization's logo. This can only be called by an admin or owner of the organization.
+ *
+ * ```typescript
+ * import {uploadOrganizationLogo} from '@verdocs/js-sdk';
+ *
+ * await uploadOrganizationLogo((VerdocsEndpoint.getDefault(), file);
+ * ```
+ */
+const uploadOrganizationLogo = (endpoint, file, onUploadProgress) => {
+    const formData = new FormData();
+    formData.append('document', file, file.name);
+    return endpoint.api //
+        .post(`/v2/organizations/logo`, formData, {
+        timeout: 120000,
+        onUploadProgress: (event) => {
+            const total = event.total || 1;
+            const loaded = event.loaded || 0;
+            onUploadProgress?.(Math.floor((loaded * 100) / (total || 1)), loaded, total || 1);
+        },
+    })
+        .then((r) => r.data);
+};
+/**
+ * Update the organization's thumbnail. This can only be called by an admin or owner of the organization.
+ *
+ * ```typescript
+ * import {uploadOrganizationThumbnail} from '@verdocs/js-sdk';
+ *
+ * await uploadOrganizationThumbnail((VerdocsEndpoint.getDefault(), file);
+ * ```
+ */
+const uploadOrganizationThumbnail = (endpoint, file, onUploadProgress) => {
+    const formData = new FormData();
+    formData.append('document', file, file.name);
+    return endpoint.api //
+        .post(`/v2/organizations/thumbnail`, formData, {
+        timeout: 120000,
+        onUploadProgress: (event) => {
+            const total = event.total || 1;
+            const loaded = event.loaded || 0;
+            onUploadProgress?.(Math.floor((loaded * 100) / (total || 1)), loaded, total || 1);
+        },
+    })
+        .then((r) => r.data);
+};
 
 /**
  * Webhooks are callback triggers from Verdocs to your servers that notify your applications
@@ -2672,6 +2747,29 @@ const deleteProfile = (endpoint, profileId) => endpoint.api //
 const createProfile = (endpoint, params) => endpoint.api //
     .post('/v2/profiles', params)
     .then((r) => r.data);
+/**
+ * Update the caller's profile photo. This can only be called for the user's "current" profile.
+ *
+ * ```typescript
+ * import {uploadProfilePhoto} from '@verdocs/js-sdk';
+ *
+ * await uploadProfilePhoto((VerdocsEndpoint.getDefault(), file);
+ * ```
+ */
+const uploadProfilePhoto = (endpoint, file, onUploadProgress) => {
+    const formData = new FormData();
+    formData.append('document', file, file.name);
+    return endpoint.api //
+        .post(`/v2/profiles/picture`, formData, {
+        timeout: 120000,
+        onUploadProgress: (event) => {
+            const total = event.total || 1;
+            const loaded = event.loaded || 0;
+            onUploadProgress?.(Math.floor((loaded * 100) / (total || 1)), loaded, total || 1);
+        },
+    })
+        .then((r) => r.data);
+};
 
 exports.AtoB = AtoB;
 exports.Countries = Countries;
@@ -2754,6 +2852,7 @@ exports.getFieldsForRole = getFieldsForRole;
 exports.getGroup = getGroup;
 exports.getGroups = getGroups;
 exports.getInPersonLink = getInPersonLink;
+exports.getKbaStatus = getKbaStatus;
 exports.getMatchingCountry = getMatchingCountry;
 exports.getNextRecipient = getNextRecipient;
 exports.getNotifications = getNotifications;
@@ -2825,6 +2924,9 @@ exports.searchEnvelopes = searchEnvelopes;
 exports.searchTemplates = searchTemplates;
 exports.sendDelegate = sendDelegate;
 exports.setWebhooks = setWebhooks;
+exports.submitKbaChallengeResponse = submitKbaChallengeResponse;
+exports.submitKbaIdentity = submitKbaIdentity;
+exports.submitKbaPin = submitKbaPin;
 exports.switchProfile = switchProfile;
 exports.throttledGetEnvelope = throttledGetEnvelope;
 exports.throttledGetTemplate = throttledGetTemplate;
@@ -2846,6 +2948,9 @@ exports.updateTemplate = updateTemplate;
 exports.updateTemplateReminder = updateTemplateReminder;
 exports.updateTemplateRole = updateTemplateRole;
 exports.uploadEnvelopeFieldAttachment = uploadEnvelopeFieldAttachment;
+exports.uploadOrganizationLogo = uploadOrganizationLogo;
+exports.uploadOrganizationThumbnail = uploadOrganizationThumbnail;
+exports.uploadProfilePhoto = uploadProfilePhoto;
 exports.userCanAct = userCanAct;
 exports.userCanBuildTemplate = userCanBuildTemplate;
 exports.userCanCancelEnvelope = userCanCancelEnvelope;