Java
SDK Reference
Java
SDK Reference
A list of all methods in the SignplusService service. Click on the method name to view detailed information about that method.
| Methods | Description |
|---|---|
| createEnvelope | Create new envelope |
| createEnvelopeFromTemplate | Create new envelope from template |
| listEnvelopes | List envelopes |
| getEnvelope | Get envelope |
| deleteEnvelope | Delete envelope |
| getEnvelopeDocument | Get envelope document |
| getEnvelopeDocuments | Get envelope documents |
| addEnvelopeDocument | Add envelope document |
| setEnvelopeDynamicFields | Set envelope dynamic fields |
| addEnvelopeSigningSteps | Add envelope signing steps |
| sendEnvelope | Send envelope for signature |
| duplicateEnvelope | Duplicate envelope |
| voidEnvelope | Void envelope |
| renameEnvelope | Rename envelope |
| setEnvelopeComment | Set envelope comment |
| setEnvelopeNotification | Set envelope notification |
| setEnvelopeExpirationDate | Set envelope expiration date |
| setEnvelopeLegalityLevel | Set envelope legality level |
| getEnvelopeAnnotations | Get envelope annotations |
| getEnvelopeDocumentAnnotations | Get envelope document annotations |
| addEnvelopeAnnotation | Add envelope annotation |
| deleteEnvelopeAnnotation | Delete envelope annotation |
| createTemplate | Create new template |
| listTemplates | List templates |
| getTemplate | Get template |
| deleteTemplate | Delete template |
| duplicateTemplate | Duplicate template |
| addTemplateDocument | Add template document |
| getTemplateDocument | Get template document |
| getTemplateDocuments | Get template documents |
| addTemplateSigningSteps | Add template signing steps |
| renameTemplate | Rename template |
| setTemplateComment | Set template comment |
| setTemplateNotification | Set template notification |
| getTemplateAnnotations | Get template annotations |
| getDocumentTemplateAnnotations | Get document template annotations |
| addTemplateAnnotation | Add template annotation |
| deleteTemplateAnnotation | Delete template annotation |
| createWebhook | Create webhook |
| listWebhooks | List webhooks |
| deleteWebhook | Delete webhook |
createEnvelope
Create new envelope
- HTTP Method:
POST - Endpoint:
/envelope
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| createEnvelopeRequest | CreateEnvelopeRequest | Request Body |
Return Type
Envelope
Example Usage Code Snippet
import alohi.signplus.signplus.Signplus;
import alohi.signplus.signplus.config.SignplusConfig;
import alohi.signplus.signplus.models.CreateEnvelopeRequest;
import alohi.signplus.signplus.models.Envelope;
import alohi.signplus.signplus.models.EnvelopeFlowType;
import alohi.signplus.signplus.models.EnvelopeLegalityLevel;
public class Main {
public static void main(String[] args) {
SignplusConfig config = SignplusConfig.builder().accessToken("YOUR_ACCESS_TOKEN").build();
Signplus signplus = new Signplus(config);
CreateEnvelopeRequest createEnvelopeRequest = CreateEnvelopeRequest
.builder()
.name("name")
.flowType(EnvelopeFlowType.REQUEST_SIGNATURE)
.legalityLevel(EnvelopeLegalityLevel.SES)
.expiresAt(8L)
.comment("comment")
.sandbox(false)
.build();
Envelope response = signplus.signplusService.createEnvelope(createEnvelopeRequest);
System.out.println(response);
}
}
createEnvelopeFromTemplate
Create new envelope from template
- HTTP Method:
POST - Endpoint:
/envelope/from_template/{template_id}
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| templateId | String | ||
| createEnvelopeFromTemplateRequest | CreateEnvelopeFromTemplateRequest | Request Body |
Return Type
Envelope
Example Usage Code Snippet
import alohi.signplus.signplus.Signplus;
import alohi.signplus.signplus.config.SignplusConfig;
import alohi.signplus.signplus.models.CreateEnvelopeFromTemplateRequest;
import alohi.signplus.signplus.models.Envelope;
public class Main {
public static void main(String[] args) {
SignplusConfig config = SignplusConfig.builder().accessToken("YOUR_ACCESS_TOKEN").build();
Signplus signplus = new Signplus(config);
CreateEnvelopeFromTemplateRequest createEnvelopeFromTemplateRequest = CreateEnvelopeFromTemplateRequest
.builder()
.name("name")
.comment("comment")
.sandbox(false)
.build();
Envelope response = signplus.signplusService.createEnvelopeFromTemplate(
"template_id",
createEnvelopeFromTemplateRequest
);
System.out.println(response);
}
}
listEnvelopes
List envelopes
- HTTP Method:
POST - Endpoint:
/envelopes
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| listEnvelopesRequest | ListEnvelopesRequest | Request Body |
Return Type
ListEnvelopesResponse
Example Usage Code Snippet
import alohi.signplus.signplus.Signplus;
import alohi.signplus.signplus.config.SignplusConfig;
import alohi.signplus.signplus.models.EnvelopeOrderField;
import alohi.signplus.signplus.models.EnvelopeStatus;
import alohi.signplus.signplus.models.ListEnvelopesRequest;
import alohi.signplus.signplus.models.ListEnvelopesResponse;
import java.util.Arrays;
import java.util.List;
public class Main {
public static void main(String[] args) {
SignplusConfig config = SignplusConfig.builder().accessToken("YOUR_ACCESS_TOKEN").build();
Signplus signplus = new Signplus(config);
List<String> tags = Arrays.asList("tags");
List<String> ids = Arrays.asList("ids");
List<EnvelopeStatus> statuses = Arrays.asList(EnvelopeStatus.DRAFT);
List<String> folderIds = Arrays.asList("folder_ids");
ListEnvelopesRequest listEnvelopesRequest = ListEnvelopesRequest
.builder()
.name("name")
.tags(tags)
.comment("comment")
.ids(ids)
.statuses(statuses)
.folderIds(folderIds)
.onlyRootFolder(true)
.dateFrom(4L)
.dateTo(7L)
.uid("uid")
.first(8L)
.last(9L)
.after("after")
.before("before")
.orderField(EnvelopeOrderField.CREATION_DATE)
.ascending(false)
.includeTrash(true)
.build();
ListEnvelopesResponse response = signplus.signplusService.listEnvelopes(listEnvelopesRequest);
System.out.println(response);
}
}
getEnvelope
Get envelope
- HTTP Method:
GET - Endpoint:
/envelope/{envelope_id}
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| envelopeId | String |
Return Type
Envelope
Example Usage Code Snippet
import alohi.signplus.signplus.Signplus;
import alohi.signplus.signplus.config.SignplusConfig;
import alohi.signplus.signplus.models.Envelope;
public class Main {
public static void main(String[] args) {
SignplusConfig config = SignplusConfig.builder().accessToken("YOUR_ACCESS_TOKEN").build();
Signplus signplus = new Signplus(config);
Envelope response = signplus.signplusService.getEnvelope("envelope_id");
System.out.println(response);
}
}
deleteEnvelope
Delete envelope
- HTTP Method:
DELETE - Endpoint:
/envelope/{envelope_id}
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| envelopeId | String |
Example Usage Code Snippet
import alohi.signplus.signplus.Signplus;
import alohi.signplus.signplus.config.SignplusConfig;
public class Main {
public static void main(String[] args) {
SignplusConfig config = SignplusConfig.builder().accessToken("YOUR_ACCESS_TOKEN").build();
Signplus signplus = new Signplus(config);
signplus.signplusService.deleteEnvelope("envelope_id");
}
}
getEnvelopeDocument
Get envelope document
- HTTP Method:
GET - Endpoint:
/envelope/{envelope_id}/document/{document_id}
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| envelopeId | String | ||
| documentId | String |
Return Type
Document
Example Usage Code Snippet
import alohi.signplus.signplus.Signplus;
import alohi.signplus.signplus.config.SignplusConfig;
import alohi.signplus.signplus.models.Document;
public class Main {
public static void main(String[] args) {
SignplusConfig config = SignplusConfig.builder().accessToken("YOUR_ACCESS_TOKEN").build();
Signplus signplus = new Signplus(config);
Document response = signplus.signplusService.getEnvelopeDocument("envelope_id", "document_id");
System.out.println(response);
}
}
getEnvelopeDocuments
Get envelope documents
- HTTP Method:
GET - Endpoint:
/envelope/{envelope_id}/documents
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| envelopeId | String |
Return Type
ListEnvelopeDocumentsResponse
Example Usage Code Snippet
import alohi.signplus.signplus.Signplus;
import alohi.signplus.signplus.config.SignplusConfig;
import alohi.signplus.signplus.models.ListEnvelopeDocumentsResponse;
public class Main {
public static void main(String[] args) {
SignplusConfig config = SignplusConfig.builder().accessToken("YOUR_ACCESS_TOKEN").build();
Signplus signplus = new Signplus(config);
ListEnvelopeDocumentsResponse response = signplus.signplusService.getEnvelopeDocuments("envelope_id");
System.out.println(response);
}
}
addEnvelopeDocument
Add envelope document
- HTTP Method:
POST - Endpoint:
/envelope/{envelope_id}/document
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| envelopeId | String | ||
| addEnvelopeDocumentRequest | AddEnvelopeDocumentRequest | Request Body |
Return Type
Document
Example Usage Code Snippet
import alohi.signplus.signplus.Signplus;
import alohi.signplus.signplus.config.SignplusConfig;
import alohi.signplus.signplus.models.AddEnvelopeDocumentRequest;
import alohi.signplus.signplus.models.Document;
public class Main {
public static void main(String[] args) {
SignplusConfig config = SignplusConfig.builder().accessToken("YOUR_ACCESS_TOKEN").build();
Signplus signplus = new Signplus(config);
AddEnvelopeDocumentRequest addEnvelopeDocumentRequest = AddEnvelopeDocumentRequest.builder().file(file).build();
Document response = signplus.signplusService.addEnvelopeDocument("envelope_id", addEnvelopeDocumentRequest);
System.out.println(response);
}
}
setEnvelopeDynamicFields
Set envelope dynamic fields
- HTTP Method:
PUT - Endpoint:
/envelope/{envelope_id}/dynamic_fields
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| envelopeId | String | ||
| setEnvelopeDynamicFieldsRequest | SetEnvelopeDynamicFieldsRequest | Request Body |
Return Type
Envelope
Example Usage Code Snippet
import alohi.signplus.signplus.Signplus;
import alohi.signplus.signplus.config.SignplusConfig;
import alohi.signplus.signplus.models.DynamicField;
import alohi.signplus.signplus.models.Envelope;
import alohi.signplus.signplus.models.SetEnvelopeDynamicFieldsRequest;
import java.util.Arrays;
import java.util.List;
public class Main {
public static void main(String[] args) {
SignplusConfig config = SignplusConfig.builder().accessToken("YOUR_ACCESS_TOKEN").build();
Signplus signplus = new Signplus(config);
DynamicField dynamicField = DynamicField.builder().name("name").value("value").build();
List<DynamicField> dynamicFields = Arrays.asList(dynamicField);
SetEnvelopeDynamicFieldsRequest setEnvelopeDynamicFieldsRequest = SetEnvelopeDynamicFieldsRequest
.builder()
.dynamicFields(dynamicFields)
.build();
Envelope response = signplus.signplusService.setEnvelopeDynamicFields(
"envelope_id",
setEnvelopeDynamicFieldsRequest
);
System.out.println(response);
}
}
addEnvelopeSigningSteps
Add envelope signing steps
- HTTP Method:
POST - Endpoint:
/envelope/{envelope_id}/signing_steps
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| envelopeId | String | ||
| addEnvelopeSigningStepsRequest | AddEnvelopeSigningStepsRequest | Request Body |
Return Type
Envelope
Example Usage Code Snippet
import alohi.signplus.signplus.Signplus;
import alohi.signplus.signplus.config.SignplusConfig;
import alohi.signplus.signplus.models.AddEnvelopeSigningStepsRequest;
import alohi.signplus.signplus.models.Envelope;
import alohi.signplus.signplus.models.Recipient;
import alohi.signplus.signplus.models.RecipientRole;
import alohi.signplus.signplus.models.RecipientVerification;
import alohi.signplus.signplus.models.RecipientVerificationType;
import alohi.signplus.signplus.models.SigningStep;
import java.util.Arrays;
import java.util.List;
public class Main {
public static void main(String[] args) {
SignplusConfig config = SignplusConfig.builder().accessToken("YOUR_ACCESS_TOKEN").build();
Signplus signplus = new Signplus(config);
RecipientVerification recipientVerification = RecipientVerification
.builder()
.type(RecipientVerificationType.SMS)
.value("value")
.build();
Recipient recipient = Recipient
.builder()
.id("id")
.uid("uid")
.name("name")
.email("email")
.role(RecipientRole.SIGNER)
.verification(recipientVerification)
.build();
List<Recipient> recipients = Arrays.asList(recipient);
SigningStep signingStep = SigningStep.builder().recipients(recipients).build();
List<SigningStep> signingSteps = Arrays.asList(signingStep);
AddEnvelopeSigningStepsRequest addEnvelopeSigningStepsRequest = AddEnvelopeSigningStepsRequest
.builder()
.signingSteps(signingSteps)
.build();
Envelope response = signplus.signplusService.addEnvelopeSigningSteps("envelope_id", addEnvelopeSigningStepsRequest);
System.out.println(response);
}
}
sendEnvelope
Send envelope for signature
- HTTP Method:
POST - Endpoint:
/envelope/{envelope_id}/send
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| envelopeId | String |
Return Type
Envelope
Example Usage Code Snippet
import alohi.signplus.signplus.Signplus;
import alohi.signplus.signplus.config.SignplusConfig;
import alohi.signplus.signplus.models.Envelope;
public class Main {
public static void main(String[] args) {
SignplusConfig config = SignplusConfig.builder().accessToken("YOUR_ACCESS_TOKEN").build();
Signplus signplus = new Signplus(config);
Envelope response = signplus.signplusService.sendEnvelope("envelope_id");
System.out.println(response);
}
}
duplicateEnvelope
Duplicate envelope
- HTTP Method:
POST - Endpoint:
/envelope/{envelope_id}/duplicate
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| envelopeId | String |
Return Type
Envelope
Example Usage Code Snippet
import alohi.signplus.signplus.Signplus;
import alohi.signplus.signplus.config.SignplusConfig;
import alohi.signplus.signplus.models.Envelope;
public class Main {
public static void main(String[] args) {
SignplusConfig config = SignplusConfig.builder().accessToken("YOUR_ACCESS_TOKEN").build();
Signplus signplus = new Signplus(config);
Envelope response = signplus.signplusService.duplicateEnvelope("envelope_id");
System.out.println(response);
}
}
voidEnvelope
Void envelope
- HTTP Method:
PUT - Endpoint:
/envelope/{envelope_id}/void
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| envelopeId | String |
Return Type
Envelope
Example Usage Code Snippet
import alohi.signplus.signplus.Signplus;
import alohi.signplus.signplus.config.SignplusConfig;
import alohi.signplus.signplus.models.Envelope;
public class Main {
public static void main(String[] args) {
SignplusConfig config = SignplusConfig.builder().accessToken("YOUR_ACCESS_TOKEN").build();
Signplus signplus = new Signplus(config);
Envelope response = signplus.signplusService.voidEnvelope("envelope_id");
System.out.println(response);
}
}
renameEnvelope
Rename envelope
- HTTP Method:
PUT - Endpoint:
/envelope/{envelope_id}/rename
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| envelopeId | String | ||
| renameEnvelopeRequest | RenameEnvelopeRequest | Request Body |
Return Type
Envelope
Example Usage Code Snippet
import alohi.signplus.signplus.Signplus;
import alohi.signplus.signplus.config.SignplusConfig;
import alohi.signplus.signplus.models.Envelope;
import alohi.signplus.signplus.models.RenameEnvelopeRequest;
public class Main {
public static void main(String[] args) {
SignplusConfig config = SignplusConfig.builder().accessToken("YOUR_ACCESS_TOKEN").build();
Signplus signplus = new Signplus(config);
RenameEnvelopeRequest renameEnvelopeRequest = RenameEnvelopeRequest.builder().name("name").build();
Envelope response = signplus.signplusService.renameEnvelope("envelope_id", renameEnvelopeRequest);
System.out.println(response);
}
}
setEnvelopeComment
Set envelope comment
- HTTP Method:
PUT - Endpoint:
/envelope/{envelope_id}/set_comment
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| envelopeId | String | ||
| setEnvelopeCommentRequest | SetEnvelopeCommentRequest | Request Body |
Return Type
Envelope
Example Usage Code Snippet
import alohi.signplus.signplus.Signplus;
import alohi.signplus.signplus.config.SignplusConfig;
import alohi.signplus.signplus.models.Envelope;
import alohi.signplus.signplus.models.SetEnvelopeCommentRequest;
public class Main {
public static void main(String[] args) {
SignplusConfig config = SignplusConfig.builder().accessToken("YOUR_ACCESS_TOKEN").build();
Signplus signplus = new Signplus(config);
SetEnvelopeCommentRequest setEnvelopeCommentRequest = SetEnvelopeCommentRequest
.builder()
.comment("comment")
.build();
Envelope response = signplus.signplusService.setEnvelopeComment("envelope_id", setEnvelopeCommentRequest);
System.out.println(response);
}
}
setEnvelopeNotification
Set envelope notification
- HTTP Method:
PUT - Endpoint:
/envelope/{envelope_id}/set_notification
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| envelopeId | String | ||
| envelopeNotification | EnvelopeNotification | Request Body |
Return Type
Envelope
Example Usage Code Snippet
import alohi.signplus.signplus.Signplus;
import alohi.signplus.signplus.config.SignplusConfig;
import alohi.signplus.signplus.models.Envelope;
import alohi.signplus.signplus.models.EnvelopeNotification;
public class Main {
public static void main(String[] args) {
SignplusConfig config = SignplusConfig.builder().accessToken("YOUR_ACCESS_TOKEN").build();
Signplus signplus = new Signplus(config);
EnvelopeNotification envelopeNotification = EnvelopeNotification
.builder()
.subject("subject")
.message("message")
.reminderInterval(1L)
.build();
Envelope response = signplus.signplusService.setEnvelopeNotification("envelope_id", envelopeNotification);
System.out.println(response);
}
}
setEnvelopeExpirationDate
Set envelope expiration date
- HTTP Method:
PUT - Endpoint:
/envelope/{envelope_id}/set_expiration_date
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| envelopeId | String | ||
| setEnvelopeExpirationRequest | SetEnvelopeExpirationRequest | Request Body |
Return Type
Envelope
Example Usage Code Snippet
import alohi.signplus.signplus.Signplus;
import alohi.signplus.signplus.config.SignplusConfig;
import alohi.signplus.signplus.models.Envelope;
import alohi.signplus.signplus.models.SetEnvelopeExpirationRequest;
public class Main {
public static void main(String[] args) {
SignplusConfig config = SignplusConfig.builder().accessToken("YOUR_ACCESS_TOKEN").build();
Signplus signplus = new Signplus(config);
SetEnvelopeExpirationRequest setEnvelopeExpirationRequest = SetEnvelopeExpirationRequest
.builder()
.expiresAt(6L)
.build();
Envelope response = signplus.signplusService.setEnvelopeExpirationDate("envelope_id", setEnvelopeExpirationRequest);
System.out.println(response);
}
}
setEnvelopeLegalityLevel
Set envelope legality level
- HTTP Method:
PUT - Endpoint:
/envelope/{envelope_id}/set_legality_level
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| envelopeId | String | ||
| setEnvelopeLegalityLevelRequest | SetEnvelopeLegalityLevelRequest | Request Body |
Return Type
Envelope
Example Usage Code Snippet
import alohi.signplus.signplus.Signplus;
import alohi.signplus.signplus.config.SignplusConfig;
import alohi.signplus.signplus.models.Envelope;
import alohi.signplus.signplus.models.EnvelopeLegalityLevel;
import alohi.signplus.signplus.models.SetEnvelopeLegalityLevelRequest;
public class Main {
public static void main(String[] args) {
SignplusConfig config = SignplusConfig.builder().accessToken("YOUR_ACCESS_TOKEN").build();
Signplus signplus = new Signplus(config);
SetEnvelopeLegalityLevelRequest setEnvelopeLegalityLevelRequest = SetEnvelopeLegalityLevelRequest
.builder()
.legalityLevel(EnvelopeLegalityLevel.SES)
.build();
Envelope response = signplus.signplusService.setEnvelopeLegalityLevel(
"envelope_id",
setEnvelopeLegalityLevelRequest
);
System.out.println(response);
}
}
getEnvelopeAnnotations
Get envelope annotations
- HTTP Method:
GET - Endpoint:
/envelope/{envelope_id}/annotations
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| envelopeId | String | ID of the envelope |
Return Type
List<Annotation>
Example Usage Code Snippet
import alohi.signplus.signplus.Signplus;
import alohi.signplus.signplus.config.SignplusConfig;
import alohi.signplus.signplus.models.Annotation;
import java.util.List;
public class Main {
public static void main(String[] args) {
SignplusConfig config = SignplusConfig.builder().accessToken("YOUR_ACCESS_TOKEN").build();
Signplus signplus = new Signplus(config);
List<Annotation> response = signplus.signplusService.getEnvelopeAnnotations("envelope_id");
System.out.println(response);
}
}
getEnvelopeDocumentAnnotations
Get envelope document annotations
- HTTP Method:
GET - Endpoint:
/envelope/{envelope_id}/annotations/{document_id}
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| envelopeId | String | ID of the envelope | |
| documentId | String | ID of document |
Return Type
ListEnvelopeDocumentAnnotationsResponse
Example Usage Code Snippet
import alohi.signplus.signplus.Signplus;
import alohi.signplus.signplus.config.SignplusConfig;
import alohi.signplus.signplus.models.ListEnvelopeDocumentAnnotationsResponse;
public class Main {
public static void main(String[] args) {
SignplusConfig config = SignplusConfig.builder().accessToken("YOUR_ACCESS_TOKEN").build();
Signplus signplus = new Signplus(config);
ListEnvelopeDocumentAnnotationsResponse response = signplus.signplusService.getEnvelopeDocumentAnnotations(
"envelope_id",
"document_id"
);
System.out.println(response);
}
}
addEnvelopeAnnotation
Add envelope annotation
- HTTP Method:
POST - Endpoint:
/envelope/{envelope_id}/annotation
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| envelopeId | String | ID of the envelope | |
| addAnnotationRequest | AddAnnotationRequest | Request Body |
Return Type
Annotation
Example Usage Code Snippet
import alohi.signplus.signplus.Signplus;
import alohi.signplus.signplus.config.SignplusConfig;
import alohi.signplus.signplus.models.AddAnnotationRequest;
import alohi.signplus.signplus.models.Annotation;
import alohi.signplus.signplus.models.AnnotationCheckbox;
import alohi.signplus.signplus.models.AnnotationCheckboxStyle;
import alohi.signplus.signplus.models.AnnotationDateTime;
import alohi.signplus.signplus.models.AnnotationDateTimeFormat;
import alohi.signplus.signplus.models.AnnotationFont;
import alohi.signplus.signplus.models.AnnotationFontFamily;
import alohi.signplus.signplus.models.AnnotationInitials;
import alohi.signplus.signplus.models.AnnotationSignature;
import alohi.signplus.signplus.models.AnnotationText;
import alohi.signplus.signplus.models.AnnotationType;
public class Main {
public static void main(String[] args) {
SignplusConfig config = SignplusConfig.builder().accessToken("YOUR_ACCESS_TOKEN").build();
Signplus signplus = new Signplus(config);
AnnotationSignature annotationSignature = AnnotationSignature.builder().id("id").build();
AnnotationInitials annotationInitials = AnnotationInitials.builder().id("id").build();
AnnotationFont annotationFont = AnnotationFont
.builder()
.family(AnnotationFontFamily.UNKNOWN)
.italic(true)
.bold(true)
.build();
AnnotationText annotationText = AnnotationText
.builder()
.size(0.75D)
.color(0.4D)
.value("value")
.tooltip("tooltip")
.dynamicFieldName("dynamic_field_name")
.font(annotationFont)
.build();
AnnotationDateTime annotationDateTime = AnnotationDateTime
.builder()
.size(2.34D)
.font(annotationFont)
.color("color")
.autoFill(false)
.timezone("timezone")
.timestamp(6L)
.format(AnnotationDateTimeFormat.DMY_NUMERIC_SLASH)
.build();
AnnotationCheckbox annotationCheckbox = AnnotationCheckbox
.builder()
.checked(true)
.style(AnnotationCheckboxStyle.CIRCLE_CHECK)
.build();
AddAnnotationRequest addAnnotationRequest = AddAnnotationRequest
.builder()
.recipientId("recipient_id")
.documentId("document_id")
.page(5L)
.x(2.83D)
.y(1.27D)
.width(5.18D)
.height(4.34D)
.required(false)
.type(AnnotationType.TEXT)
.signature(annotationSignature)
.initials(annotationInitials)
.text(annotationText)
.datetime(annotationDateTime)
.checkbox(annotationCheckbox)
.build();
Annotation response = signplus.signplusService.addEnvelopeAnnotation("envelope_id", addAnnotationRequest);
System.out.println(response);
}
}
deleteEnvelopeAnnotation
Delete envelope annotation
- HTTP Method:
DELETE - Endpoint:
/envelope/{envelope_id}/annotation/{annotation_id}
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| envelopeId | String | ID of the envelope | |
| annotationId | String | ID of the annotation to delete |
Example Usage Code Snippet
import alohi.signplus.signplus.Signplus;
import alohi.signplus.signplus.config.SignplusConfig;
public class Main {
public static void main(String[] args) {
SignplusConfig config = SignplusConfig.builder().accessToken("YOUR_ACCESS_TOKEN").build();
Signplus signplus = new Signplus(config);
signplus.signplusService.deleteEnvelopeAnnotation("envelope_id", "annotation_id");
}
}
createTemplate
Create new template
- HTTP Method:
POST - Endpoint:
/template
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| createTemplateRequest | CreateTemplateRequest | Request Body |
Return Type
Template
Example Usage Code Snippet
import alohi.signplus.signplus.Signplus;
import alohi.signplus.signplus.config.SignplusConfig;
import alohi.signplus.signplus.models.CreateTemplateRequest;
import alohi.signplus.signplus.models.Template;
public class Main {
public static void main(String[] args) {
SignplusConfig config = SignplusConfig.builder().accessToken("YOUR_ACCESS_TOKEN").build();
Signplus signplus = new Signplus(config);
CreateTemplateRequest createTemplateRequest = CreateTemplateRequest.builder().name("name").build();
Template response = signplus.signplusService.createTemplate(createTemplateRequest);
System.out.println(response);
}
}
listTemplates
List templates
- HTTP Method:
POST - Endpoint:
/templates
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| listTemplatesRequest | ListTemplatesRequest | Request Body |
Return Type
ListTemplatesResponse
Example Usage Code Snippet
import alohi.signplus.signplus.Signplus;
import alohi.signplus.signplus.config.SignplusConfig;
import alohi.signplus.signplus.models.ListTemplatesRequest;
import alohi.signplus.signplus.models.ListTemplatesResponse;
import alohi.signplus.signplus.models.TemplateOrderField;
import java.util.Arrays;
import java.util.List;
public class Main {
public static void main(String[] args) {
SignplusConfig config = SignplusConfig.builder().accessToken("YOUR_ACCESS_TOKEN").build();
Signplus signplus = new Signplus(config);
List<String> tags = Arrays.asList("tags");
List<String> ids = Arrays.asList("ids");
ListTemplatesRequest listTemplatesRequest = ListTemplatesRequest
.builder()
.name("name")
.tags(tags)
.ids(ids)
.first(2L)
.last(0L)
.after("after")
.before("before")
.orderField(TemplateOrderField.TEMPLATE_ID)
.ascending(true)
.build();
ListTemplatesResponse response = signplus.signplusService.listTemplates(listTemplatesRequest);
System.out.println(response);
}
}
getTemplate
Get template
- HTTP Method:
GET - Endpoint:
/template/{template_id}
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| templateId | String |
Return Type
Template
Example Usage Code Snippet
import alohi.signplus.signplus.Signplus;
import alohi.signplus.signplus.config.SignplusConfig;
import alohi.signplus.signplus.models.Template;
public class Main {
public static void main(String[] args) {
SignplusConfig config = SignplusConfig.builder().accessToken("YOUR_ACCESS_TOKEN").build();
Signplus signplus = new Signplus(config);
Template response = signplus.signplusService.getTemplate("template_id");
System.out.println(response);
}
}
deleteTemplate
Delete template
- HTTP Method:
DELETE - Endpoint:
/template/{template_id}
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| templateId | String |
Example Usage Code Snippet
import alohi.signplus.signplus.Signplus;
import alohi.signplus.signplus.config.SignplusConfig;
public class Main {
public static void main(String[] args) {
SignplusConfig config = SignplusConfig.builder().accessToken("YOUR_ACCESS_TOKEN").build();
Signplus signplus = new Signplus(config);
signplus.signplusService.deleteTemplate("template_id");
}
}
duplicateTemplate
Duplicate template
- HTTP Method:
POST - Endpoint:
/template/{template_id}/duplicate
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| templateId | String |
Return Type
Template
Example Usage Code Snippet
import alohi.signplus.signplus.Signplus;
import alohi.signplus.signplus.config.SignplusConfig;
import alohi.signplus.signplus.models.Template;
public class Main {
public static void main(String[] args) {
SignplusConfig config = SignplusConfig.builder().accessToken("YOUR_ACCESS_TOKEN").build();
Signplus signplus = new Signplus(config);
Template response = signplus.signplusService.duplicateTemplate("template_id");
System.out.println(response);
}
}
addTemplateDocument
Add template document
- HTTP Method:
POST - Endpoint:
/template/{template_id}/document
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| templateId | String | ||
| addTemplateDocumentRequest | AddTemplateDocumentRequest | Request Body |
Return Type
Document
Example Usage Code Snippet
import alohi.signplus.signplus.Signplus;
import alohi.signplus.signplus.config.SignplusConfig;
import alohi.signplus.signplus.models.AddTemplateDocumentRequest;
import alohi.signplus.signplus.models.Document;
public class Main {
public static void main(String[] args) {
SignplusConfig config = SignplusConfig.builder().accessToken("YOUR_ACCESS_TOKEN").build();
Signplus signplus = new Signplus(config);
AddTemplateDocumentRequest addTemplateDocumentRequest = AddTemplateDocumentRequest.builder().file(file).build();
Document response = signplus.signplusService.addTemplateDocument("template_id", addTemplateDocumentRequest);
System.out.println(response);
}
}
getTemplateDocument
Get template document
- HTTP Method:
GET - Endpoint:
/template/{template_id}/document/{document_id}
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| templateId | String | ||
| documentId | String |
Return Type
Document
Example Usage Code Snippet
import alohi.signplus.signplus.Signplus;
import alohi.signplus.signplus.config.SignplusConfig;
import alohi.signplus.signplus.models.Document;
public class Main {
public static void main(String[] args) {
SignplusConfig config = SignplusConfig.builder().accessToken("YOUR_ACCESS_TOKEN").build();
Signplus signplus = new Signplus(config);
Document response = signplus.signplusService.getTemplateDocument("template_id", "document_id");
System.out.println(response);
}
}
getTemplateDocuments
Get template documents
- HTTP Method:
GET - Endpoint:
/template/{template_id}/documents
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| templateId | String |
Return Type
ListTemplateDocumentsResponse
Example Usage Code Snippet
import alohi.signplus.signplus.Signplus;
import alohi.signplus.signplus.config.SignplusConfig;
import alohi.signplus.signplus.models.ListTemplateDocumentsResponse;
public class Main {
public static void main(String[] args) {
SignplusConfig config = SignplusConfig.builder().accessToken("YOUR_ACCESS_TOKEN").build();
Signplus signplus = new Signplus(config);
ListTemplateDocumentsResponse response = signplus.signplusService.getTemplateDocuments("template_id");
System.out.println(response);
}
}
addTemplateSigningSteps
Add template signing steps
- HTTP Method:
POST - Endpoint:
/template/{template_id}/signing_steps
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| templateId | String | ||
| addTemplateSigningStepsRequest | AddTemplateSigningStepsRequest | Request Body |
Return Type
Template
Example Usage Code Snippet
import alohi.signplus.signplus.Signplus;
import alohi.signplus.signplus.config.SignplusConfig;
import alohi.signplus.signplus.models.AddTemplateSigningStepsRequest;
import alohi.signplus.signplus.models.Template;
import alohi.signplus.signplus.models.TemplateRecipient;
import alohi.signplus.signplus.models.TemplateRecipientRole;
import alohi.signplus.signplus.models.TemplateSigningStep;
import java.util.Arrays;
import java.util.List;
public class Main {
public static void main(String[] args) {
SignplusConfig config = SignplusConfig.builder().accessToken("YOUR_ACCESS_TOKEN").build();
Signplus signplus = new Signplus(config);
TemplateRecipient templateRecipient = TemplateRecipient
.builder()
.id("id")
.uid("uid")
.name("name")
.email("email")
.role(TemplateRecipientRole.SIGNER)
.build();
List<TemplateRecipient> recipients = Arrays.asList(templateRecipient);
TemplateSigningStep templateSigningStep = TemplateSigningStep.builder().recipients(recipients).build();
List<TemplateSigningStep> signingSteps = Arrays.asList(templateSigningStep);
AddTemplateSigningStepsRequest addTemplateSigningStepsRequest = AddTemplateSigningStepsRequest
.builder()
.signingSteps(signingSteps)
.build();
Template response = signplus.signplusService.addTemplateSigningSteps("template_id", addTemplateSigningStepsRequest);
System.out.println(response);
}
}
renameTemplate
Rename template
- HTTP Method:
PUT - Endpoint:
/template/{template_id}/rename
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| templateId | String | ||
| renameTemplateRequest | RenameTemplateRequest | Request Body |
Return Type
Template
Example Usage Code Snippet
import alohi.signplus.signplus.Signplus;
import alohi.signplus.signplus.config.SignplusConfig;
import alohi.signplus.signplus.models.RenameTemplateRequest;
import alohi.signplus.signplus.models.Template;
public class Main {
public static void main(String[] args) {
SignplusConfig config = SignplusConfig.builder().accessToken("YOUR_ACCESS_TOKEN").build();
Signplus signplus = new Signplus(config);
RenameTemplateRequest renameTemplateRequest = RenameTemplateRequest.builder().name("name").build();
Template response = signplus.signplusService.renameTemplate("template_id", renameTemplateRequest);
System.out.println(response);
}
}
setTemplateComment
Set template comment
- HTTP Method:
PUT - Endpoint:
/template/{template_id}/set_comment
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| templateId | String | ||
| setTemplateCommentRequest | SetTemplateCommentRequest | Request Body |
Return Type
Template
Example Usage Code Snippet
import alohi.signplus.signplus.Signplus;
import alohi.signplus.signplus.config.SignplusConfig;
import alohi.signplus.signplus.models.SetTemplateCommentRequest;
import alohi.signplus.signplus.models.Template;
public class Main {
public static void main(String[] args) {
SignplusConfig config = SignplusConfig.builder().accessToken("YOUR_ACCESS_TOKEN").build();
Signplus signplus = new Signplus(config);
SetTemplateCommentRequest setTemplateCommentRequest = SetTemplateCommentRequest
.builder()
.comment("comment")
.build();
Template response = signplus.signplusService.setTemplateComment("template_id", setTemplateCommentRequest);
System.out.println(response);
}
}
setTemplateNotification
Set template notification
- HTTP Method:
PUT - Endpoint:
/template/{template_id}/set_notification
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| templateId | String | ||
| envelopeNotification | EnvelopeNotification | Request Body |
Return Type
Template
Example Usage Code Snippet
import alohi.signplus.signplus.Signplus;
import alohi.signplus.signplus.config.SignplusConfig;
import alohi.signplus.signplus.models.EnvelopeNotification;
import alohi.signplus.signplus.models.Template;
public class Main {
public static void main(String[] args) {
SignplusConfig config = SignplusConfig.builder().accessToken("YOUR_ACCESS_TOKEN").build();
Signplus signplus = new Signplus(config);
EnvelopeNotification envelopeNotification = EnvelopeNotification
.builder()
.subject("subject")
.message("message")
.reminderInterval(1L)
.build();
Template response = signplus.signplusService.setTemplateNotification("template_id", envelopeNotification);
System.out.println(response);
}
}
getTemplateAnnotations
Get template annotations
- HTTP Method:
GET - Endpoint:
/template/{template_id}/annotations
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| templateId | String | ID of the template |
Return Type
ListTemplateAnnotationsResponse
Example Usage Code Snippet
import alohi.signplus.signplus.Signplus;
import alohi.signplus.signplus.config.SignplusConfig;
import alohi.signplus.signplus.models.ListTemplateAnnotationsResponse;
public class Main {
public static void main(String[] args) {
SignplusConfig config = SignplusConfig.builder().accessToken("YOUR_ACCESS_TOKEN").build();
Signplus signplus = new Signplus(config);
ListTemplateAnnotationsResponse response = signplus.signplusService.getTemplateAnnotations("template_id");
System.out.println(response);
}
}
getDocumentTemplateAnnotations
Get document template annotations
- HTTP Method:
GET - Endpoint:
/template/{template_id}/annotations/{document_id}
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| templateId | String | ID of the template | |
| documentId | String | ID of document |
Return Type
ListTemplateDocumentAnnotationsResponse
Example Usage Code Snippet
import alohi.signplus.signplus.Signplus;
import alohi.signplus.signplus.config.SignplusConfig;
import alohi.signplus.signplus.models.ListTemplateDocumentAnnotationsResponse;
public class Main {
public static void main(String[] args) {
SignplusConfig config = SignplusConfig.builder().accessToken("YOUR_ACCESS_TOKEN").build();
Signplus signplus = new Signplus(config);
ListTemplateDocumentAnnotationsResponse response = signplus.signplusService.getDocumentTemplateAnnotations(
"template_id",
"document_id"
);
System.out.println(response);
}
}
addTemplateAnnotation
Add template annotation
- HTTP Method:
POST - Endpoint:
/template/{template_id}/annotation
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| templateId | String | ID of the template | |
| addAnnotationRequest | AddAnnotationRequest | Request Body |
Return Type
Annotation
Example Usage Code Snippet
import alohi.signplus.signplus.Signplus;
import alohi.signplus.signplus.config.SignplusConfig;
import alohi.signplus.signplus.models.AddAnnotationRequest;
import alohi.signplus.signplus.models.Annotation;
import alohi.signplus.signplus.models.AnnotationCheckbox;
import alohi.signplus.signplus.models.AnnotationCheckboxStyle;
import alohi.signplus.signplus.models.AnnotationDateTime;
import alohi.signplus.signplus.models.AnnotationDateTimeFormat;
import alohi.signplus.signplus.models.AnnotationFont;
import alohi.signplus.signplus.models.AnnotationFontFamily;
import alohi.signplus.signplus.models.AnnotationInitials;
import alohi.signplus.signplus.models.AnnotationSignature;
import alohi.signplus.signplus.models.AnnotationText;
import alohi.signplus.signplus.models.AnnotationType;
public class Main {
public static void main(String[] args) {
SignplusConfig config = SignplusConfig.builder().accessToken("YOUR_ACCESS_TOKEN").build();
Signplus signplus = new Signplus(config);
AnnotationSignature annotationSignature = AnnotationSignature.builder().id("id").build();
AnnotationInitials annotationInitials = AnnotationInitials.builder().id("id").build();
AnnotationFont annotationFont = AnnotationFont
.builder()
.family(AnnotationFontFamily.UNKNOWN)
.italic(true)
.bold(true)
.build();
AnnotationText annotationText = AnnotationText
.builder()
.size(0.75D)
.color(0.4D)
.value("value")
.tooltip("tooltip")
.dynamicFieldName("dynamic_field_name")
.font(annotationFont)
.build();
AnnotationDateTime annotationDateTime = AnnotationDateTime
.builder()
.size(2.34D)
.font(annotationFont)
.color("color")
.autoFill(false)
.timezone("timezone")
.timestamp(6L)
.format(AnnotationDateTimeFormat.DMY_NUMERIC_SLASH)
.build();
AnnotationCheckbox annotationCheckbox = AnnotationCheckbox
.builder()
.checked(true)
.style(AnnotationCheckboxStyle.CIRCLE_CHECK)
.build();
AddAnnotationRequest addAnnotationRequest = AddAnnotationRequest
.builder()
.recipientId("recipient_id")
.documentId("document_id")
.page(5L)
.x(2.83D)
.y(1.27D)
.width(5.18D)
.height(4.34D)
.required(false)
.type(AnnotationType.TEXT)
.signature(annotationSignature)
.initials(annotationInitials)
.text(annotationText)
.datetime(annotationDateTime)
.checkbox(annotationCheckbox)
.build();
Annotation response = signplus.signplusService.addTemplateAnnotation("template_id", addAnnotationRequest);
System.out.println(response);
}
}
deleteTemplateAnnotation
Delete template annotation
- HTTP Method:
DELETE - Endpoint:
/template/{template_id}/annotation/{annotation_id}
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| templateId | String | ID of the template | |
| annotationId | String | ID of the annotation to delete |
Example Usage Code Snippet
import alohi.signplus.signplus.Signplus;
import alohi.signplus.signplus.config.SignplusConfig;
public class Main {
public static void main(String[] args) {
SignplusConfig config = SignplusConfig.builder().accessToken("YOUR_ACCESS_TOKEN").build();
Signplus signplus = new Signplus(config);
signplus.signplusService.deleteTemplateAnnotation("template_id", "annotation_id");
}
}
createWebhook
Create webhook
- HTTP Method:
POST - Endpoint:
/webhook
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| createWebhookRequest | CreateWebhookRequest | Request Body |
Return Type
Webhook
Example Usage Code Snippet
import alohi.signplus.signplus.Signplus;
import alohi.signplus.signplus.config.SignplusConfig;
import alohi.signplus.signplus.models.CreateWebhookRequest;
import alohi.signplus.signplus.models.Webhook;
import alohi.signplus.signplus.models.WebhookEvent;
public class Main {
public static void main(String[] args) {
SignplusConfig config = SignplusConfig.builder().accessToken("YOUR_ACCESS_TOKEN").build();
Signplus signplus = new Signplus(config);
CreateWebhookRequest createWebhookRequest = CreateWebhookRequest
.builder()
.event(WebhookEvent.ENVELOPE_EXPIRED)
.target("target")
.build();
Webhook response = signplus.signplusService.createWebhook(createWebhookRequest);
System.out.println(response);
}
}
listWebhooks
List webhooks
- HTTP Method:
POST - Endpoint:
/webhooks
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| listWebhooksRequest | ListWebhooksRequest | Request Body |
Return Type
ListWebhooksResponse
Example Usage Code Snippet
import alohi.signplus.signplus.Signplus;
import alohi.signplus.signplus.config.SignplusConfig;
import alohi.signplus.signplus.models.ListWebhooksRequest;
import alohi.signplus.signplus.models.ListWebhooksResponse;
import alohi.signplus.signplus.models.WebhookEvent;
public class Main {
public static void main(String[] args) {
SignplusConfig config = SignplusConfig.builder().accessToken("YOUR_ACCESS_TOKEN").build();
Signplus signplus = new Signplus(config);
ListWebhooksRequest listWebhooksRequest = ListWebhooksRequest
.builder()
.webhookId("webhook_id")
.event(WebhookEvent.ENVELOPE_EXPIRED)
.build();
ListWebhooksResponse response = signplus.signplusService.listWebhooks(listWebhooksRequest);
System.out.println(response);
}
}
deleteWebhook
Delete webhook
- HTTP Method:
DELETE - Endpoint:
/webhook/{webhook_id}
Parameters
| Name | Type | Required | Description |
|---|---|---|---|
| webhookId | String |
Example Usage Code Snippet
import alohi.signplus.signplus.Signplus;
import alohi.signplus.signplus.config.SignplusConfig;
public class Main {
public static void main(String[] args) {
SignplusConfig config = SignplusConfig.builder().accessToken("YOUR_ACCESS_TOKEN").build();
Signplus signplus = new Signplus(config);
signplus.signplusService.deleteWebhook("webhook_id");
}
}
Models
Document
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| id | String | Unique identifier of the document | |
| name | String | Name of the document | |
| filename | String | Filename of the document | |
| pageCount | Long | Number of pages in the document | |
| pages | List<Page> | List of pages in the document |
Models
CreateEnvelopeRequest
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| name | String | Name of the envelope | |
| flowType | EnvelopeFlowType | Flow type of the envelope (REQUEST_SIGNATURE is a request for signature, SIGN_MYSELF is a self-signing flow) | |
| legalityLevel | EnvelopeLegalityLevel | Legal level of the envelope (SES is Simple Electronic Signature, QES_EIDAS is Qualified Electronic Signature, QES_ZERTES is Qualified Electronic Signature with Zertes) | |
| expiresAt | Long | Unix timestamp of the expiration date | |
| comment | String | Comment for the envelope | |
| sandbox | Boolean | Whether the envelope is created in sandbox mode |
Models
ListEnvelopesRequest
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| name | String | Name of the envelope | |
| tags | List<String> | List of tags | |
| comment | String | Comment of the envelope | |
| ids | List<String> | List of envelope IDs | |
| statuses | List<EnvelopeStatus> | List of envelope statuses | |
| folderIds | List<String> | List of folder IDs | |
| onlyRootFolder | Boolean | Whether to only list envelopes in the root folder | |
| dateFrom | Long | Unix timestamp of the start date | |
| dateTo | Long | Unix timestamp of the end date | |
| uid | String | Unique identifier of the user | |
| first | Long | ||
| last | Long | ||
| after | String | ||
| before | String | ||
| orderField | EnvelopeOrderField | Field to order envelopes by | |
| ascending | Boolean | Whether to order envelopes in ascending order | |
| includeTrash | Boolean | Whether to include envelopes in the trash |
Models
EnvelopeNotification
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| subject | String | Subject of the notification | |
| message | String | Message of the notification | |
| reminderInterval | Long | Interval in days to send reminder |
Models
ListTemplatesRequest
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| name | String | Name of the template | |
| tags | List<String> | List of tag templates | |
| ids | List<String> | List of templates IDs | |
| first | Long | ||
| last | Long | ||
| after | String | ||
| before | String | ||
| orderField | TemplateOrderField | Field to order templates by | |
| ascending | Boolean | Whether to order templates in ascending order |
Models
SetTemplateCommentRequest
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| comment | String | Comment for the template |
Models
Template
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| id | String | Unique identifier of the template | |
| name | String | Name of the template | |
| comment | String | Comment for the template | |
| pages | Long | Total number of pages in the template | |
| legalityLevel | EnvelopeLegalityLevel | Legal level of the envelope (SES is Simple Electronic Signature, QES_EIDAS is Qualified Electronic Signature, QES_ZERTES is Qualified Electronic Signature with Zertes) | |
| createdAt | Long | Unix timestamp of the creation date | |
| updatedAt | Long | Unix timestamp of the last modification date | |
| expirationDelay | Long | Expiration delay added to the current time when an envelope is created from this template | |
| numRecipients | Long | Number of recipients in the envelope | |
| signingSteps | List<TemplateSigningStep> | ||
| documents | List<Document> | ||
| notification | EnvelopeNotification | ||
| dynamicFields | List<String> | List of dynamic fields |
Models
RecipientVerificationType
Type of signature verification (SMS sends a code via SMS, PASSCODE requires a code to be entered)
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| SMS | String | “SMS” | |
| PASSCODE | String | “PASSCODE” |
Models
AddEnvelopeSigningStepsRequest
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| signingSteps | List<SigningStep> | List of signing steps |
Models
AnnotationFontFamily
Font family of the text
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| UNKNOWN | String | “UNKNOWN” | |
| SERIF | String | “SERIF” | |
| SANS | String | “SANS” | |
| MONO | String | “MONO” |
Models
AddTemplateSigningStepsRequest
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| signingSteps | List<TemplateSigningStep> | List of signing steps |
Models
SetEnvelopeCommentRequest
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| comment | String | Comment for the envelope |
Models
TemplateOrderField
Field to order templates by
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| TEMPLATE_ID | String | “TEMPLATE_ID” | |
| TEMPLATE_CREATION_DATE | String | “TEMPLATE_CREATION_DATE” | |
| TEMPLATE_MODIFICATION_DATE | String | “TEMPLATE_MODIFICATION_DATE” | |
| TEMPLATE_NAME | String | “TEMPLATE_NAME” |
Models
EnvelopeOrderField
Field to order envelopes by
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| CREATION_DATE | String | “CREATION_DATE” | |
| MODIFICATION_DATE | String | “MODIFICATION_DATE” | |
| NAME | String | “NAME” | |
| STATUS | String | “STATUS” | |
| LAST_DOCUMENT_CHANGE | String | “LAST_DOCUMENT_CHANGE” |
Models
AddEnvelopeDocumentRequest
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| file | byte[] | File to upload in binary format |
Models
ListWebhooksRequest
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| webhookId | String | ID of the webhook | |
| event | WebhookEvent | Event of the webhook |
Models
SetEnvelopeLegalityLevelRequest
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| legalityLevel | EnvelopeLegalityLevel | Legal level of the envelope (SES is Simple Electronic Signature, QES_EIDAS is Qualified Electronic Signature, QES_ZERTES is Qualified Electronic Signature with Zertes) |
Models
SetEnvelopeExpirationRequest
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| expiresAt | Long | Unix timestamp of the expiration date |
Models
AnnotationText
Text annotation (null if annotation is not a text)
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| size | Double | Font size of the text in pt | |
| color | Double | Text color in 32bit representation | |
| value | String | Text content of the annotation | |
| tooltip | String | Tooltip of the annotation | |
| dynamicFieldName | String | Name of the dynamic field | |
| font | AnnotationFont |
Models
AnnotationCheckbox
Checkbox annotation (null if annotation is not a checkbox)
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| checked | Boolean | Whether the checkbox is checked | |
| style | AnnotationCheckboxStyle | Style of the checkbox |
Models
Envelope
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| id | String | Unique identifier of the envelope | |
| name | String | Name of the envelope | |
| comment | String | Comment for the envelope | |
| pages | Long | Total number of pages in the envelope | |
| flowType | EnvelopeFlowType | Flow type of the envelope (REQUEST_SIGNATURE is a request for signature, SIGN_MYSELF is a self-signing flow) | |
| legalityLevel | EnvelopeLegalityLevel | Legal level of the envelope (SES is Simple Electronic Signature, QES_EIDAS is Qualified Electronic Signature, QES_ZERTES is Qualified Electronic Signature with Zertes) | |
| status | EnvelopeStatus | Status of the envelope | |
| createdAt | Long | Unix timestamp of the creation date | |
| updatedAt | Long | Unix timestamp of the last modification date | |
| expiresAt | Long | Unix timestamp of the expiration date | |
| numRecipients | Long | Number of recipients in the envelope | |
| isDuplicable | Boolean | Whether the envelope can be duplicated | |
| signingSteps | List<SigningStep> | ||
| documents | List<Document> | ||
| notification | EnvelopeNotification |
Models
AddTemplateDocumentRequest
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| file | byte[] | File to upload in binary format |
Models
TemplateRecipient
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| id | String | Unique identifier of the recipient | |
| uid | String | Unique identifier of the user associated with the recipient | |
| name | String | Name of the recipient | |
| String | Email of the recipient | ||
| role | TemplateRecipientRole | Role of the recipient (SIGNER signs the document, RECEIVES_COPY receives a copy of the document, IN_PERSON_SIGNER signs the document in person, SENDER sends the document) |
Models
AddAnnotationRequest
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| documentId | String | ID of the document | |
| page | Long | Page number where the annotation is placed | |
| x | Double | X coordinate of the annotation (in % of the page width from 0 to 100) from the top left corner | |
| y | Double | Y coordinate of the annotation (in % of the page height from 0 to 100) from the top left corner | |
| width | Double | Width of the annotation (in % of the page width from 0 to 100) | |
| height | Double | Height of the annotation (in % of the page height from 0 to 100) | |
| type | AnnotationType | Type of the annotation | |
| recipientId | String | ID of the recipient | |
| required | Boolean | ||
| signature | AnnotationSignature | Signature annotation (null if annotation is not a signature) | |
| initials | AnnotationInitials | Initials annotation (null if annotation is not initials) | |
| text | AnnotationText | Text annotation (null if annotation is not a text) | |
| datetime | AnnotationDateTime | Date annotation (null if annotation is not a date) | |
| checkbox | AnnotationCheckbox | Checkbox annotation (null if annotation is not a checkbox) |
Models
ListEnvelopeDocumentAnnotationsResponse
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| annotations | List<Annotation> |
Models
EnvelopeStatus
Status of the envelope
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| DRAFT | String | “DRAFT” | |
| IN_PROGRESS | String | “IN_PROGRESS” | |
| COMPLETED | String | “COMPLETED” | |
| EXPIRED | String | “EXPIRED” | |
| DECLINED | String | “DECLINED” | |
| VOIDED | String | “VOIDED” | |
| PENDING | String | “PENDING” |
Models
RecipientVerification
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| type | RecipientVerificationType | Type of signature verification (SMS sends a code via SMS, PASSCODE requires a code to be entered) | |
| value | String |
Models
AnnotationCheckboxStyle
Style of the checkbox
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| CIRCLE_CHECK | String | “CIRCLE_CHECK” | |
| CIRCLE_FULL | String | “CIRCLE_FULL” | |
| SQUARE_CHECK | String | “SQUARE_CHECK” | |
| SQUARE_FULL | String | “SQUARE_FULL” | |
| CHECK_MARK | String | “CHECK_MARK” | |
| TIMES_SQUARE | String | “TIMES_SQUARE” |
Models
SigningStep
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| recipients | List<Recipient> | List of recipients |
Models
AnnotationDateTime
Date annotation (null if annotation is not a date)
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| size | Double | Font size of the text in pt | |
| font | AnnotationFont | ||
| color | String | Color of the text in hex format | |
| autoFill | Boolean | Whether the date should be automatically filled | |
| timezone | String | Timezone of the date | |
| timestamp | Long | Unix timestamp of the date | |
| format | AnnotationDateTimeFormat | Format of the date time (DMY_NUMERIC_SLASH is day/month/year with slashes, MDY_NUMERIC_SLASH is month/day/year with slashes, YMD_NUMERIC_SLASH is year/month/day with slashes, DMY_NUMERIC_DASH_SHORT is day/month/year with dashes, DMY_NUMERIC_DASH is day/month/year with dashes, YMD_NUMERIC_DASH is year/month/day with dashes, MDY_TEXT_DASH_SHORT is month/day/year with dashes, MDY_TEXT_SPACE_SHORT is month/day/year with spaces, MDY_TEXT_SPACE is month/day/year with spaces) |
Models
CreateTemplateRequest
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| name | String |
Models
ListTemplateDocumentsResponse
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| documents | List<Document> |
Models
AnnotationInitials
Initials annotation (null if annotation is not initials)
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| id | String | Unique identifier of the annotation initials |
Models
AnnotationFont
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| family | AnnotationFontFamily | Font family of the text | |
| italic | Boolean | Whether the text is italic | |
| bold | Boolean | Whether the text is bold |
Models
AnnotationType
Type of the annotation
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| TEXT | String | “TEXT” | |
| SIGNATURE | String | “SIGNATURE” | |
| INITIALS | String | “INITIALS” | |
| CHECKBOX | String | “CHECKBOX” | |
| DATE | String | “DATE” |
Models
Webhook
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| id | String | Unique identifier of the webhook | |
| event | WebhookEvent | Event of the webhook | |
| target | String | Target URL of the webhook |
Models
RenameTemplateRequest
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| name | String | Name of the template |
Models
ListTemplatesResponse
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| hasNextPage | Boolean | Whether there is a next page | |
| hasPreviousPage | Boolean | Whether there is a previous page | |
| templates | List<Template> |
Models
RecipientRole
Role of the recipient (SIGNER signs the document, RECEIVES_COPY receives a copy of the document, IN_PERSON_SIGNER signs the document in person, SENDER sends the document)
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| SIGNER | String | “SIGNER” | |
| RECEIVES_COPY | String | “RECEIVES_COPY” | |
| IN_PERSON_SIGNER | String | “IN_PERSON_SIGNER” |
Models
Annotation
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| id | String | Unique identifier of the annotation | |
| recipientId | String | ID of the recipient | |
| documentId | String | ID of the document | |
| page | Long | Page number where the annotation is placed | |
| x | Double | X coordinate of the annotation (in % of the page width from 0 to 100) from the top left corner | |
| y | Double | Y coordinate of the annotation (in % of the page height from 0 to 100) from the top left corner | |
| width | Double | Width of the annotation (in % of the page width from 0 to 100) | |
| height | Double | Height of the annotation (in % of the page height from 0 to 100) | |
| required | Boolean | Whether the annotation is required | |
| type | AnnotationType | Type of the annotation | |
| signature | AnnotationSignature | Signature annotation (null if annotation is not a signature) | |
| initials | AnnotationInitials | Initials annotation (null if annotation is not initials) | |
| text | AnnotationText | Text annotation (null if annotation is not a text) | |
| datetime | AnnotationDateTime | Date annotation (null if annotation is not a date) | |
| checkbox | AnnotationCheckbox | Checkbox annotation (null if annotation is not a checkbox) |
Models
DynamicField
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| name | String | Name of the dynamic field | |
| value | String | Value of the dynamic field |
Models
AnnotationDateTimeFormat
Format of the date time (DMY_NUMERIC_SLASH is day/month/year with slashes, MDY_NUMERIC_SLASH is month/day/year with slashes, YMD_NUMERIC_SLASH is year/month/day with slashes, DMY_NUMERIC_DASH_SHORT is day/month/year with dashes, DMY_NUMERIC_DASH is day/month/year with dashes, YMD_NUMERIC_DASH is year/month/day with dashes, MDY_TEXT_DASH_SHORT is month/day/year with dashes, MDY_TEXT_SPACE_SHORT is month/day/year with spaces, MDY_TEXT_SPACE is month/day/year with spaces)
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| DMY_NUMERIC_SLASH | String | “DMY_NUMERIC_SLASH” | |
| MDY_NUMERIC_SLASH | String | “MDY_NUMERIC_SLASH” | |
| YMD_NUMERIC_SLASH | String | “YMD_NUMERIC_SLASH” | |
| DMY_NUMERIC_DASH_SHORT | String | “DMY_NUMERIC_DASH_SHORT” | |
| DMY_NUMERIC_DASH | String | “DMY_NUMERIC_DASH” | |
| YMD_NUMERIC_DASH | String | “YMD_NUMERIC_DASH” | |
| MDY_TEXT_DASH_SHORT | String | “MDY_TEXT_DASH_SHORT” | |
| MDY_TEXT_SPACE_SHORT | String | “MDY_TEXT_SPACE_SHORT” | |
| MDY_TEXT_SPACE | String | “MDY_TEXT_SPACE” |
Models
EnvelopeFlowType
Flow type of the envelope (REQUEST_SIGNATURE is a request for signature, SIGN_MYSELF is a self-signing flow)
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| REQUEST_SIGNATURE | String | “REQUEST_SIGNATURE” | |
| SIGN_MYSELF | String | “SIGN_MYSELF” |
Models
EnvelopeLegalityLevel
Legal level of the envelope (SES is Simple Electronic Signature, QES_EIDAS is Qualified Electronic Signature, QES_ZERTES is Qualified Electronic Signature with Zertes)
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| SES | String | “SES” | |
| QES_EIDAS | String | “QES_EIDAS” | |
| QES_ZERTES | String | “QES_ZERTES” |
Models
TemplateRecipientRole
Role of the recipient (SIGNER signs the document, RECEIVES_COPY receives a copy of the document, IN_PERSON_SIGNER signs the document in person, SENDER sends the document)
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| SIGNER | String | “SIGNER” | |
| RECEIVES_COPY | String | “RECEIVES_COPY” | |
| IN_PERSON_SIGNER | String | “IN_PERSON_SIGNER” |
Models
SetEnvelopeDynamicFieldsRequest
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| dynamicFields | List<DynamicField> | List of dynamic fields |
Models
Page
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| width | Long | Width of the page in pixels | |
| height | Long | Height of the page in pixels |
Models
TemplateSigningStep
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| recipients | List<TemplateRecipient> | List of recipients |
Models
ListEnvelopesResponse
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| hasNextPage | Boolean | Whether there is a next page | |
| hasPreviousPage | Boolean | Whether there is a previous page | |
| envelopes | List<Envelope> |
Models
Recipient
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| name | String | Name of the recipient | |
| String | Email of the recipient | ||
| role | RecipientRole | Role of the recipient (SIGNER signs the document, RECEIVES_COPY receives a copy of the document, IN_PERSON_SIGNER signs the document in person, SENDER sends the document) | |
| id | String | Unique identifier of the recipient | |
| uid | String | Unique identifier of the user associated with the recipient | |
| verification | RecipientVerification |
Models
WebhookEvent
Event of the webhook
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| ENVELOPE_EXPIRED | String | “ENVELOPE_EXPIRED” | |
| ENVELOPE_DECLINED | String | “ENVELOPE_DECLINED” | |
| ENVELOPE_VOIDED | String | “ENVELOPE_VOIDED” | |
| ENVELOPE_COMPLETED | String | “ENVELOPE_COMPLETED” |
Models
CreateWebhookRequest
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| event | WebhookEvent | Event of the webhook | |
| target | String | URL of the webhook target |
Models
CreateEnvelopeFromTemplateRequest
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| name | String | Name of the envelope | |
| comment | String | Comment for the envelope | |
| sandbox | Boolean | Whether the envelope is created in sandbox mode |
Models
ListTemplateAnnotationsResponse
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| annotations | List<Annotation> |
Models
RenameEnvelopeRequest
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| name | String | Name of the envelope |
Models
ListTemplateDocumentAnnotationsResponse
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| annotations | List<Annotation> |
Models
ListEnvelopeDocumentsResponse
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| documents | List<Document> |
Models
ListWebhooksResponse
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| webhooks | List<Webhook> |
Models
AnnotationSignature
Signature annotation (null if annotation is not a signature)
Properties
| Name | Type | Required | Description |
|---|---|---|---|
| id | String | Unique identifier of the annotation signature |