Bulk Invite Sender Tool - Java

Note:

1. If you choose to enable the "Activate Sender" option, this will trigger automatic invitations to all senders without them having to receive an activation email. However, if you choose to disable this option, especially when dealing with a large number of senders, it's advisable to request assistance by creating a support ticket at [email protected] and to utilize the tool only under the guidance of our support team. Such guidance may include:
   • Personalizing the "email.account.invitation" and "email.signup" templates
   • Requesting your IT department to whitelist our domain. This strategy is designed to prevent senders, who may not be anticipating activation emails, from mistakenly marking our domain as a phishing attempt.
2. If, by accident, senders were invited directly but you intended them to receive the activation email, the "Activate Sender" option should be deactivated. Following this, invite the senders again twice - the first call will deactivate the senders, and the second call will initiate the sending of the activation email.

In order to run this tool, you will need the following:

1. install JRE/JDK environment (1.8 or later)

2. OneSpan Sign API key or Username + Password of your account

3. a CSV file in UTF-8 encoding, which contains sender's information. (A sample file has been included in the attachment showing you the expected header format) For sender information: Firstname, Lastname, Email are specified per sender. Company name and whether to Activate your senders immediately are set in batch.

Update 2024/03/28 - v1.4.6:

1. Add a JVM argument to use system default proxy

Update 2023/11/10 - v1.4.4:

1. fixed an issue concerning the presence of reserved words, such as "roles", in sender profiles. Note:

Note:

Currently, to assign roles to sender accounts, please use the username and password method. Note that the assignment of roles via API Key is not supported at this moment.

Update 2023/05/24 - v1.4.3:

1. Fixed a bug where the sender status is only determined when importing the CSV, now sender status and company can be overwritten at any time.

Update 2021/10/26 - v1.4.1:

1. Adapted the response handling for API “GET /api/account/senders/{senderId}/roles” 

Update 2021/03/03 - v1.4.0:

1. Supports the  "Roles & Permissions" feature. In order to assign sender roles, add a "Roles" column in CSV file, enter the Role Name(s) in the cells and use semi colon(s) to separate multiple role names. An sample CSV file is also included.

2. Beautify the sender list

Update 2020/08/11 - v1.3.1:

1. Sender “company” and “status” can be either specified as CSV columns or determined in bulk during the operation. When both options are provided, whatever you’ve specified in the CSV will take priority.

Update 2020/07/17 - v1.3.0:

1."Bulk Sender Invite Tool" now features the function to update existing senders. In order to facilitate this use case, an extra step has been introduced which pulls all the existing sender's Emails to a CSV file.

You can cut the "Email" column and merge into your own CSV file, then add your customized columns. Any sender attributes can be used as column name, for example, "TimezoneId"  or "Language", case insensitive. (To update an existing sender, the "email" is the minimal requirement, so no need to fill in the first/last names, unless you want to update them)

Update 2020/06/16 - v1.2.0:

1. after execution, a report as well as a log file will be persisted to the same folder as the sender CSV file located. Although both files don't include API Key/Token, it's still suggested to delete them both after you've confirmed all senders have been successfully invited to the account. Otherwise, they could be a useful resource to troubleshoot with underlying issues during execution. (log file is locked during execution, exit the program then you get access to the content)

Update 2020/04/29 :

1. fixed the duplicated slashes in the API URLs.

Update 2020/04/03 :

1. add the proxy capability, allow to manually choose proxy ip/port or use a proxy script, also allow proxy authentication