boldsign-java

Easily integrate BoldSign's e-signature features into your Java applications. This package simplifies sending documents for signature, embedding signing ceremonies, tracking document status, downloading signed documents, and managing e-signature workflows.

Requirements

Building the API client library requires:

1. Java 1.8+
2. Maven (3.8.3+)/Gradle (7.2+)

Installation

To install the API client library to your local Maven repository, simply execute:

mvn clean install

To deploy it to a remote Maven repository instead, configure the settings of the repository and execute:

mvn clean deploy

Refer to the OSSRH Guide for more information.

Maven users

Add this dependency to your project's POM:

<dependency>
  <groupId>com.boldsign</groupId>
  <artifactId>boldsign-java</artifactId>
  <version>1.0.0-beta.1</version>
  <scope>compile</scope>
</dependency>

Gradle users

Add this dependency to your project's build file:

  repositories {
    mavenCentral()     // Needed if the 'boldsign-java' jar has been published to maven central.
    mavenLocal()       // Needed if the 'boldsign-java' jar has been published to the local maven repo.
  }

  dependencies {
     implementation "com.boldsign:boldsign-java:1.0.0-beta.1"
  }

Others

At first generate the JAR by executing:

mvn clean package

Then manually install the following JARs:

• target/boldsign-java-1.0.0-beta.1.jar
• target/lib/*.jar

Getting Started

Please follow the installation instruction and execute the following Java code:

import java.io.File;
import java.util.ArrayList;
import java.util.List;
import com.boldsign.ApiClient;
import com.boldsign.ApiException;
import com.boldsign.Configuration;
import com.boldsign.api.DocumentApi;
import com.boldsign.model.*;
import com.boldsign.model.FormField.FieldTypeEnum;

public class Example 
{
    public static void main(String[] args) throws ApiException 
    {
        ApiClient apiClient = Configuration.getDefaultApiClient();
        apiClient.setApiKey("YOUR_API_KEY");
        DocumentApi documentApi = new DocumentApi(apiClient);

        List<File> files = new ArrayList<File>();
        File file = new File("examples/documents/agreement.pdf");
        files.add(file);

        List<FormField> formFields = new ArrayList<FormField>();

        FormField signatureField = new FormField();
        signatureField.setFieldType(FieldTypeEnum.SIGNATURE);
        signatureField.setPageNumber(1);
        Rectangle rectangle = new Rectangle().x(100f).y(100f).width(100f).height(50f);
        signatureField.setBounds(rectangle);
        formFields.add(signatureField);

        List<DocumentSigner> signers = new ArrayList<DocumentSigner>();

        DocumentSigner signer = new DocumentSigner();
        signer.setName("Signer");
        signer.setEmailAddress("hankwhite@cubeflakes.com");
        signer.setFormFields(formFields);
        signers.add(signer);

        SendForSign sendForSign = new SendForSign();
        sendForSign.setTitle("Agreement");
        sendForSign.setFiles(files);
        sendForSign.setSigners(signers);

        DocumentCreated document = documentApi.sendDocument(sendForSign);
        System.out.println(document.getDocumentId());
    }
}

Documentation for API Endpoints

All URIs are relative to https://api.boldsign.com

Class	Method	HTTP request	Description
BrandingApi	brandList	GET /v1/brand/list	List all the brands.
BrandingApi	createBrand	POST /v1/brand/create	Create the brand.
BrandingApi	deleteBrand	DELETE /v1/brand/delete	Delete the brand.
BrandingApi	editBrand	POST /v1/brand/edit	Edit the brand.
BrandingApi	getBrand	GET /v1/brand/get	Get the specific brand details.
BrandingApi	resetDefaultBrand	POST /v1/brand/resetdefault	Reset default brand.
ContactsApi	contactUserList	GET /v1/contacts/list	List Contact document.
ContactsApi	createContact	POST /v1/contacts/create	Create the new Contact.
ContactsApi	deleteContacts	DELETE /v1/contacts/delete	Deletes a contact.
ContactsApi	getContact	GET /v1/contacts/get	Get summary of the contact.
ContactsApi	updateContact	PUT /v1/contacts/update	Update the contact.
CustomFieldApi	createCustomField	POST /v1/customField/create	Create the custom field.
CustomFieldApi	customFieldsList	GET /v1/customField/list	List the custom fields respective to the brand id.
CustomFieldApi	deleteCustomField	DELETE /v1/customField/delete	Delete the custom field.
CustomFieldApi	editCustomField	POST /v1/customField/edit	Edit the custom field.
CustomFieldApi	embedCustomField	POST /v1/customField/createEmbeddedCustomFieldUrl	Generates a URL for creating or modifying custom fields within your application's embedded Designer.
DocumentApi	addAuthentication	PATCH /v1/document/addAuthentication	The add authentication to recipient.
DocumentApi	addTag	PATCH /v1/document/addTags	Add the Tags in Documents.
DocumentApi	behalfDocuments	GET /v1/document/behalfList	Gets the behalf documents.
DocumentApi	changeAccessCode	PATCH /v1/document/changeAccessCode	Changes the access code for the given document signer.
DocumentApi	changeRecipient	PATCH /v1/document/changeRecipient	Change recipient details of a document.
DocumentApi	createEmbeddedRequestUrlDocument	POST /v1/document/createEmbeddedRequestUrl	Generates a send URL which embeds document sending process into your application.
DocumentApi	deleteDocument	DELETE /v1/document/delete	Delete the document.
DocumentApi	deleteTag	DELETE /v1/document/deleteTags	Delete the Tags in Documents.
DocumentApi	downloadAttachment	GET /v1/document/downloadAttachment	Download the Attachment.
DocumentApi	downloadAuditLog	GET /v1/document/downloadAuditLog	Download the audit trail document.
DocumentApi	downloadDocument	GET /v1/document/download	Download the document.
DocumentApi	extendExpiry	PATCH /v1/document/extendExpiry	Extends the expiration date of the document.
DocumentApi	getEmbeddedSignLink	GET /v1/document/getEmbeddedSignLink	Get sign link for Embedded Sign.
DocumentApi	getProperties	GET /v1/document/properties	Get summary of the document.
DocumentApi	listDocuments	GET /v1/document/list	List user documents.
DocumentApi	prefillFields	PATCH /v1/document/prefillFields	Updates the value (prefill) of the fields in the document.
DocumentApi	remindDocument	POST /v1/document/remind	Send reminder to pending signers.
DocumentApi	removeAuthentication	PATCH /v1/document/RemoveAuthentication	Remove the access code for the given document signer.
DocumentApi	revokeDocument	POST /v1/document/revoke	Revoke the document.
DocumentApi	sendDocument	POST /v1/document/send	Sends the document for sign.
DocumentApi	teamDocuments	GET /v1/document/teamlist	Get user Team documents.
PlanApi	apiCreditsCount	GET /v1/plan/apiCreditsCount	Gets the Api credits details.
SenderIdentitiesApi	createSenderIdentities	POST /v1/senderIdentities/create	Creates sender identity.
SenderIdentitiesApi	deleteSenderIdentities	DELETE /v1/senderIdentities/delete	Deletes sender identity.
SenderIdentitiesApi	listSenderIdentities	GET /v1/senderIdentities/list	Lists sender identity.
SenderIdentitiesApi	reRequestSenderIdentities	POST /v1/senderIdentities/rerequest	Rerequests denied sender identity.
SenderIdentitiesApi	resendInvitationSenderIdentities	POST /v1/senderIdentities/resendInvitation	Resends sender identity invitation.
SenderIdentitiesApi	updateSenderIdentities	POST /v1/senderIdentities/update	Updates sender identity.
TeamsApi	createTeam	POST /v1/teams/create	Create Team.
TeamsApi	getTeam	GET /v1/teams/get	Get Team details.
TeamsApi	listTeams	GET /v1/teams/list	List Teams.
TeamsApi	updateTeam	PUT /v1/teams/update	Update Team.
TemplateApi	addTag	PATCH /v1/template/addTags	Add the Tags in Templates.
TemplateApi	createEmbeddedRequestUrlTemplate	POST /v1/template/createEmbeddedRequestUrl	Generates a send URL using a template which embeds document sending process into your application.
TemplateApi	createEmbeddedTemplateUrl	POST /v1/template/createEmbeddedTemplateUrl	Generates a create URL to embeds template create process into your application.
TemplateApi	createTemplate	POST /v1/template/create	Creates a new template.
TemplateApi	deleteTag	DELETE /v1/template/deleteTags	Delete the Tags in Templates.
TemplateApi	deleteTemplate	DELETE /v1/template/delete	Deletes a template.
TemplateApi	download	GET /v1/template/download	Download the template.
TemplateApi	editTemplate	PUT /v1/template/edit	Edit and updates an existing template.
TemplateApi	getEmbeddedTemplateEditUrl	POST /v1/template/getEmbeddedTemplateEditUrl	Generates a edit URL to embeds template edit process into your application.
TemplateApi	getProperties	GET /v1/template/properties	Get summary of the template.
TemplateApi	listTemplates	GET /v1/template/list	List all the templates.
TemplateApi	mergeAndSend	POST /v1/template/mergeAndSend	Send the document by merging multiple templates.
TemplateApi	sendUsingTemplate	POST /v1/template/send	Send a document for signature using a Template.
UserApi	cancelInvitation	POST /v1/users/cancelInvitation	Cancel the users invitation.
UserApi	createUser	POST /v1/users/create	Create the user.
UserApi	getUser	GET /v1/users/get	Get summary of the user.
UserApi	listUsers	GET /v1/users/list	List user documents.
UserApi	resendInvitation	POST /v1/users/resendInvitation	Resend the users invitation.
UserApi	updateUser	PUT /v1/users/update	Update new User role.

Documentation for Models

• AccessCodeDetail
• AccessCodeDetails
• AttachmentInfo
• AuditTrail
• BehalfDocument
• BehalfDocumentRecords
• BehalfOf
• BillingViewModel
• BrandCreated
• BrandCustomFieldDetails
• BrandingMessage
• BrandingRecords
• ChangeRecipient
• ConditionalRule
• ContactCreated
• ContactDetails
• ContactPageDetails
• ContactsDetails
• ContactsList
• CreateContactResponse
• CreateSenderIdentityRequest
• CreateTeamRequest
• CreateTemplateRequest
• CreateUser
• CustomDomainSettings
• CustomFieldCollection
• CustomFieldMessage
• CustomFormField
• DeleteCustomFieldReply
• Document
• DocumentCC
• DocumentCcDetails
• DocumentCreated
• DocumentExpirySettings
• DocumentFiles
• DocumentFormFields
• DocumentInfo
• DocumentProperties
• DocumentReassign
• DocumentRecords
• DocumentSenderDetail
• DocumentSigner
• DocumentSignerDetails
• DocumentTags
• EditSenderIdentityRequest
• EditTemplateRequest
• EditableDateFieldSettings
• EmbeddedCreateTemplateRequest
• EmbeddedCustomFieldCreated
• EmbeddedDocumentRequest
• EmbeddedSendCreated
• EmbeddedSendTemplateFormRequest
• EmbeddedSigningLink
• EmbeddedTemplateCreated
• EmbeddedTemplateEditRequest
• EmbeddedTemplateEdited
• ErrorResult
• ExistingFormField
• ExtendExpiry
• FileInfo
• Font
• FormField
• FormGroup
• FormulaFieldSettings
• IdVerification
• IdentityVerificationSettings
• ImageInfo
• MergeAndSendForSignForm
• NotificationSettings
• PageDetails
• PhoneNumber
• PrefillField
• PrefillFieldRequest
• ProblemDetails
• RecipientNotificationSettings
• Rectangle
• ReminderMessage
• ReminderSettings
• RemoveAuthentication
• RevokeDocument
• Role
• Roles
• SendForSign
• SendForSignFromTemplateForm
• SenderIdentityList
• SenderIdentityViewModel
• Size
• TeamCreated
• TeamDocumentRecords
• TeamListResponse
• TeamPageDetails
• TeamResponse
• TeamUpdateRequest
• TeamUsers
• Teams
• Template
• TemplateCC
• TemplateCreated
• TemplateFormFields
• TemplateProperties
• TemplateRecords
• TemplateRole
• TemplateSenderDetail
• TemplateSenderDetails
• TemplateSharedTemplateDetail
• TemplateSignerDetails
• TemplateTag
• TextTagDefinition
• TextTagOffset
• UpdateUser
• UserPageDetails
• UserProperties
• UserRecords
• UsersDetails
• Validation
• ViewBrandDetails
• ViewCustomFieldDetails

Documentation for Authorization

Authentication schemes defined for the API:

Bearer

• Type: API key
• API key parameter name: Authorization
• Location: HTTP header

X-API-KEY

• Type: API key
• API key parameter name: X-API-KEY
• Location: HTTP header

Recommendation

It's recommended to create an instance of ApiClient per thread in a multithreaded environment to avoid any potential issues.

Author

support@boldsign.com