A list of all methods in the SignplusService service. Click on the method name to view detailed information about that method.

MethodsDescription
createEnvelopeCreate new envelope
createEnvelopeFromTemplateCreate new envelope from template
listEnvelopesList envelopes
getEnvelopeGet envelope
deleteEnvelopeDelete envelope
getEnvelopeDocumentGet envelope document
getEnvelopeDocumentsGet envelope documents
addEnvelopeDocumentAdd envelope document
setEnvelopeDynamicFieldsSet envelope dynamic fields
addEnvelopeSigningStepsAdd envelope signing steps
sendEnvelopeSend envelope for signature
duplicateEnvelopeDuplicate envelope
voidEnvelopeVoid envelope
renameEnvelopeRename envelope
setEnvelopeCommentSet envelope comment
setEnvelopeNotificationSet envelope notification
setEnvelopeExpirationDateSet envelope expiration date
setEnvelopeLegalityLevelSet envelope legality level
getEnvelopeAnnotationsGet envelope annotations
getEnvelopeDocumentAnnotationsGet envelope document annotations
addEnvelopeAnnotationAdd envelope annotation
deleteEnvelopeAnnotationDelete envelope annotation
createTemplateCreate new template
listTemplatesList templates
getTemplateGet template
deleteTemplateDelete template
duplicateTemplateDuplicate template
addTemplateDocumentAdd template document
getTemplateDocumentGet template document
getTemplateDocumentsGet template documents
addTemplateSigningStepsAdd template signing steps
renameTemplateRename template
setTemplateCommentSet template comment
setTemplateNotificationSet template notification
getTemplateAnnotationsGet template annotations
getDocumentTemplateAnnotationsGet document template annotations
addTemplateAnnotationAdd template annotation
deleteTemplateAnnotationDelete template annotation
createWebhookCreate webhook
listWebhooksList webhooks
deleteWebhookDelete webhook

​
createEnvelope

Create new envelope

  • HTTP Method: POST
  • Endpoint: /envelope

Parameters

NameTypeRequiredDescription
createEnvelopeRequestCreateEnvelopeRequest✅Request Body

Return Type

Envelope

Example Usage Code Snippet

import com.alohi.signplus.Signplus;
import com.alohi.signplus.config.SignplusConfig;
import com.alohi.signplus.models.CreateEnvelopeRequest;
import com.alohi.signplus.models.Envelope;
import com.alohi.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")
      .legalityLevel(EnvelopeLegalityLevel.SES)
      .expiresAt(1L)
      .comment("comment")
      .sandbox(true)
      .build();

    Envelope response = signplus.signplus.createEnvelope(createEnvelopeRequest);

    System.out.println(response);
  }
}

​
createEnvelopeFromTemplate

Create new envelope from template

  • HTTP Method: POST
  • Endpoint: /envelope/from_template/{template_id}

Parameters

NameTypeRequiredDescription
templateIdString✅
createEnvelopeFromTemplateRequestCreateEnvelopeFromTemplateRequest✅Request Body

Return Type

Envelope

Example Usage Code Snippet

import com.alohi.signplus.Signplus;
import com.alohi.signplus.config.SignplusConfig;
import com.alohi.signplus.models.CreateEnvelopeFromTemplateRequest;
import com.alohi.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(true)
      .build();

    Envelope response = signplus.signplus.createEnvelopeFromTemplate("template_id", createEnvelopeFromTemplateRequest);

    System.out.println(response);
  }
}

​
listEnvelopes

List envelopes

  • HTTP Method: POST
  • Endpoint: /envelopes

Parameters

NameTypeRequiredDescription
listEnvelopesRequestListEnvelopesRequest❌Request Body

Return Type

ListEnvelopesResponse

Example Usage Code Snippet

import com.alohi.signplus.Signplus;
import com.alohi.signplus.config.SignplusConfig;
import com.alohi.signplus.models.EnvelopeOrderField;
import com.alohi.signplus.models.EnvelopeStatus;
import com.alohi.signplus.models.ListEnvelopesRequest;
import com.alohi.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(false)
      .dateFrom(0L)
      .dateTo(0L)
      .uid("uid")
      .first(7L)
      .last(8L)
      .after("after")
      .before("before")
      .orderField(EnvelopeOrderField.CREATION_DATE)
      .ascending(false)
      .includeTrash(false)
      .build();

    ListEnvelopesResponse response = signplus.signplus.listEnvelopes(listEnvelopesRequest);

    System.out.println(response);
  }
}

​
getEnvelope

Get envelope

  • HTTP Method: GET
  • Endpoint: /envelope/{envelope_id}

Parameters

NameTypeRequiredDescription
envelopeIdString✅

Return Type

Envelope

Example Usage Code Snippet

import com.alohi.signplus.Signplus;
import com.alohi.signplus.config.SignplusConfig;
import com.alohi.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.signplus.getEnvelope("envelope_id");

    System.out.println(response);
  }
}

​
deleteEnvelope

Delete envelope

  • HTTP Method: DELETE
  • Endpoint: /envelope/{envelope_id}

Parameters

NameTypeRequiredDescription
envelopeIdString✅

Example Usage Code Snippet

import com.alohi.signplus.Signplus;
import com.alohi.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.signplus.deleteEnvelope("envelope_id");
  }
}

​
getEnvelopeDocument

Get envelope document

  • HTTP Method: GET
  • Endpoint: /envelope/{envelope_id}/document/{document_id}

Parameters

NameTypeRequiredDescription
envelopeIdString✅
documentIdString✅

Return Type

Document

Example Usage Code Snippet

import com.alohi.signplus.Signplus;
import com.alohi.signplus.config.SignplusConfig;
import com.alohi.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.signplus.getEnvelopeDocument("envelope_id", "document_id");

    System.out.println(response);
  }
}

​
getEnvelopeDocuments

Get envelope documents

  • HTTP Method: GET
  • Endpoint: /envelope/{envelope_id}/documents

Parameters

NameTypeRequiredDescription
envelopeIdString✅

Return Type

ListEnvelopeDocumentsResponse

Example Usage Code Snippet

import com.alohi.signplus.Signplus;
import com.alohi.signplus.config.SignplusConfig;
import com.alohi.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.signplus.getEnvelopeDocuments("envelope_id");

    System.out.println(response);
  }
}

​
addEnvelopeDocument

Add envelope document

  • HTTP Method: POST
  • Endpoint: /envelope/{envelope_id}/document

Parameters

NameTypeRequiredDescription
envelopeIdString✅
addEnvelopeDocumentRequestAddEnvelopeDocumentRequest✅Request Body

Return Type

Document

Example Usage Code Snippet

import com.alohi.signplus.Signplus;
import com.alohi.signplus.config.SignplusConfig;
import com.alohi.signplus.models.AddEnvelopeDocumentRequest;
import com.alohi.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.signplus.addEnvelopeDocument("envelope_id", addEnvelopeDocumentRequest);

    System.out.println(response);
  }
}

​
setEnvelopeDynamicFields

Set envelope dynamic fields

  • HTTP Method: PUT
  • Endpoint: /envelope/{envelope_id}/dynamic_fields

Parameters

NameTypeRequiredDescription
envelopeIdString✅
setEnvelopeDynamicFieldsRequestSetEnvelopeDynamicFieldsRequest✅Request Body

Return Type

Envelope

Example Usage Code Snippet

import com.alohi.signplus.Signplus;
import com.alohi.signplus.config.SignplusConfig;
import com.alohi.signplus.models.DynamicField;
import com.alohi.signplus.models.Envelope;
import com.alohi.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.signplus.setEnvelopeDynamicFields("envelope_id", setEnvelopeDynamicFieldsRequest);

    System.out.println(response);
  }
}

​
addEnvelopeSigningSteps

Add envelope signing steps

  • HTTP Method: POST
  • Endpoint: /envelope/{envelope_id}/signing_steps

Parameters

NameTypeRequiredDescription
envelopeIdString✅
addEnvelopeSigningStepsRequestAddEnvelopeSigningStepsRequest✅Request Body

Return Type

Envelope

Example Usage Code Snippet

import com.alohi.signplus.Signplus;
import com.alohi.signplus.config.SignplusConfig;
import com.alohi.signplus.models.AddEnvelopeSigningStepsRequest;
import com.alohi.signplus.models.Envelope;
import com.alohi.signplus.models.Recipient;
import com.alohi.signplus.models.RecipientRole;
import com.alohi.signplus.models.RecipientVerification;
import com.alohi.signplus.models.RecipientVerificationType;
import com.alohi.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.signplus.addEnvelopeSigningSteps("envelope_id", addEnvelopeSigningStepsRequest);

    System.out.println(response);
  }
}

​
sendEnvelope

Send envelope for signature

  • HTTP Method: POST
  • Endpoint: /envelope/{envelope_id}/send

Parameters

NameTypeRequiredDescription
envelopeIdString✅

Return Type

Envelope

Example Usage Code Snippet

import com.alohi.signplus.Signplus;
import com.alohi.signplus.config.SignplusConfig;
import com.alohi.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.signplus.sendEnvelope("envelope_id");

    System.out.println(response);
  }
}

​
duplicateEnvelope

Duplicate envelope

  • HTTP Method: POST
  • Endpoint: /envelope/{envelope_id}/duplicate

Parameters

NameTypeRequiredDescription
envelopeIdString✅

Return Type

Envelope

Example Usage Code Snippet

import com.alohi.signplus.Signplus;
import com.alohi.signplus.config.SignplusConfig;
import com.alohi.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.signplus.duplicateEnvelope("envelope_id");

    System.out.println(response);
  }
}

​
voidEnvelope

Void envelope

  • HTTP Method: PUT
  • Endpoint: /envelope/{envelope_id}/void

Parameters

NameTypeRequiredDescription
envelopeIdString✅

Return Type

Envelope

Example Usage Code Snippet

import com.alohi.signplus.Signplus;
import com.alohi.signplus.config.SignplusConfig;
import com.alohi.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.signplus.voidEnvelope("envelope_id");

    System.out.println(response);
  }
}

​
renameEnvelope

Rename envelope

  • HTTP Method: PUT
  • Endpoint: /envelope/{envelope_id}/rename

Parameters

NameTypeRequiredDescription
envelopeIdString✅
renameEnvelopeRequestRenameEnvelopeRequest✅Request Body

Return Type

Envelope

Example Usage Code Snippet

import com.alohi.signplus.Signplus;
import com.alohi.signplus.config.SignplusConfig;
import com.alohi.signplus.models.Envelope;
import com.alohi.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.signplus.renameEnvelope("envelope_id", renameEnvelopeRequest);

    System.out.println(response);
  }
}

​
setEnvelopeComment

Set envelope comment

  • HTTP Method: PUT
  • Endpoint: /envelope/{envelope_id}/set_comment

Parameters

NameTypeRequiredDescription
envelopeIdString✅
setEnvelopeCommentRequestSetEnvelopeCommentRequest✅Request Body

Return Type

Envelope

Example Usage Code Snippet

import com.alohi.signplus.Signplus;
import com.alohi.signplus.config.SignplusConfig;
import com.alohi.signplus.models.Envelope;
import com.alohi.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.signplus.setEnvelopeComment("envelope_id", setEnvelopeCommentRequest);

    System.out.println(response);
  }
}

​
setEnvelopeNotification

Set envelope notification

  • HTTP Method: PUT
  • Endpoint: /envelope/{envelope_id}/set_notification

Parameters

NameTypeRequiredDescription
envelopeIdString✅
envelopeNotificationEnvelopeNotification✅Request Body

Return Type

Envelope

Example Usage Code Snippet

import com.alohi.signplus.Signplus;
import com.alohi.signplus.config.SignplusConfig;
import com.alohi.signplus.models.Envelope;
import com.alohi.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.signplus.setEnvelopeNotification("envelope_id", envelopeNotification);

    System.out.println(response);
  }
}

​
setEnvelopeExpirationDate

Set envelope expiration date

  • HTTP Method: PUT
  • Endpoint: /envelope/{envelope_id}/set_expiration_date

Parameters

NameTypeRequiredDescription
envelopeIdString✅
setEnvelopeExpirationRequestSetEnvelopeExpirationRequest✅Request Body

Return Type

Envelope

Example Usage Code Snippet

import com.alohi.signplus.Signplus;
import com.alohi.signplus.config.SignplusConfig;
import com.alohi.signplus.models.Envelope;
import com.alohi.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(4L)
      .build();

    Envelope response = signplus.signplus.setEnvelopeExpirationDate("envelope_id", setEnvelopeExpirationRequest);

    System.out.println(response);
  }
}

​
setEnvelopeLegalityLevel

Set envelope legality level

  • HTTP Method: PUT
  • Endpoint: /envelope/{envelope_id}/set_legality_level

Parameters

NameTypeRequiredDescription
envelopeIdString✅
setEnvelopeLegalityLevelRequestSetEnvelopeLegalityLevelRequest✅Request Body

Return Type

Envelope

Example Usage Code Snippet

import com.alohi.signplus.Signplus;
import com.alohi.signplus.config.SignplusConfig;
import com.alohi.signplus.models.Envelope;
import com.alohi.signplus.models.EnvelopeLegalityLevel;
import com.alohi.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.signplus.setEnvelopeLegalityLevel("envelope_id", setEnvelopeLegalityLevelRequest);

    System.out.println(response);
  }
}

​
getEnvelopeAnnotations

Get envelope annotations

  • HTTP Method: GET
  • Endpoint: /envelope/{envelope_id}/annotations

Parameters

NameTypeRequiredDescription
envelopeIdString✅ID of the envelope

Return Type

List&lt;Annotation&gt;

Example Usage Code Snippet

import com.alohi.signplus.Signplus;
import com.alohi.signplus.config.SignplusConfig;
import com.alohi.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.signplus.getEnvelopeAnnotations("envelope_id");

    System.out.println(response);
  }
}

​
getEnvelopeDocumentAnnotations

Get envelope document annotations

  • HTTP Method: GET
  • Endpoint: /envelope/{envelope_id}/annotations/{document_id}

Parameters

NameTypeRequiredDescription
envelopeIdString✅ID of the envelope
documentIdString✅ID of document

Return Type

ListEnvelopeDocumentAnnotationsResponse

Example Usage Code Snippet

import com.alohi.signplus.Signplus;
import com.alohi.signplus.config.SignplusConfig;
import com.alohi.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.signplus.getEnvelopeDocumentAnnotations(
      "envelope_id",
      "document_id"
    );

    System.out.println(response);
  }
}

​
addEnvelopeAnnotation

Add envelope annotation

  • HTTP Method: POST
  • Endpoint: /envelope/{envelope_id}/annotation

Parameters

NameTypeRequiredDescription
envelopeIdString✅ID of the envelope
addAnnotationRequestAddAnnotationRequest✅Request Body

Return Type

Annotation

Example Usage Code Snippet

import com.alohi.signplus.Signplus;
import com.alohi.signplus.config.SignplusConfig;
import com.alohi.signplus.models.AddAnnotationRequest;
import com.alohi.signplus.models.Annotation;
import com.alohi.signplus.models.AnnotationCheckbox;
import com.alohi.signplus.models.AnnotationCheckboxStyle;
import com.alohi.signplus.models.AnnotationDateTime;
import com.alohi.signplus.models.AnnotationDateTimeFormat;
import com.alohi.signplus.models.AnnotationFont;
import com.alohi.signplus.models.AnnotationFontFamily;
import com.alohi.signplus.models.AnnotationInitials;
import com.alohi.signplus.models.AnnotationSignature;
import com.alohi.signplus.models.AnnotationText;
import com.alohi.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(false)
      .build();

    AnnotationText annotationText = AnnotationText
      .builder()
      .size(1.49D)
      .color(1.36D)
      .value("value")
      .tooltip("tooltip")
      .dynamicFieldName("dynamic_field_name")
      .font(annotationFont)
      .build();

    AnnotationDateTime annotationDateTime = AnnotationDateTime
      .builder()
      .size(8.29D)
      .font(annotationFont)
      .color("color")
      .autoFill(false)
      .timezone("timezone")
      .timestamp(2L)
      .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(1L)
      .x(8.95D)
      .y(1.39D)
      .width(2.77D)
      .height(6.96D)
      .required(false)
      .type(AnnotationType.TEXT)
      .signature(annotationSignature)
      .initials(annotationInitials)
      .text(annotationText)
      .datetime(annotationDateTime)
      .checkbox(annotationCheckbox)
      .build();

    Annotation response = signplus.signplus.addEnvelopeAnnotation("envelope_id", addAnnotationRequest);

    System.out.println(response);
  }
}

​
deleteEnvelopeAnnotation

Delete envelope annotation

  • HTTP Method: DELETE
  • Endpoint: /envelope/{envelope_id}/annotation/{annotation_id}

Parameters

NameTypeRequiredDescription
envelopeIdString✅ID of the envelope
annotationIdString✅ID of the annotation to delete

Example Usage Code Snippet

import com.alohi.signplus.Signplus;
import com.alohi.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.signplus.deleteEnvelopeAnnotation("envelope_id", "annotation_id");
  }
}

​
createTemplate

Create new template

  • HTTP Method: POST
  • Endpoint: /template

Parameters

NameTypeRequiredDescription
createTemplateRequestCreateTemplateRequest✅Request Body

Return Type

Template

Example Usage Code Snippet

import com.alohi.signplus.Signplus;
import com.alohi.signplus.config.SignplusConfig;
import com.alohi.signplus.models.CreateTemplateRequest;
import com.alohi.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.signplus.createTemplate(createTemplateRequest);

    System.out.println(response);
  }
}

​
listTemplates

List templates

  • HTTP Method: POST
  • Endpoint: /templates

Parameters

NameTypeRequiredDescription
listTemplatesRequestListTemplatesRequest❌Request Body

Return Type

ListTemplatesResponse

Example Usage Code Snippet

import com.alohi.signplus.Signplus;
import com.alohi.signplus.config.SignplusConfig;
import com.alohi.signplus.models.ListTemplatesRequest;
import com.alohi.signplus.models.ListTemplatesResponse;
import com.alohi.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(1L)
      .last(4L)
      .after("after")
      .before("before")
      .orderField(TemplateOrderField.TEMPLATE_ID)
      .ascending(false)
      .build();

    ListTemplatesResponse response = signplus.signplus.listTemplates(listTemplatesRequest);

    System.out.println(response);
  }
}

​
getTemplate

Get template

  • HTTP Method: GET
  • Endpoint: /template/{template_id}

Parameters

NameTypeRequiredDescription
templateIdString✅

Return Type

Template

Example Usage Code Snippet

import com.alohi.signplus.Signplus;
import com.alohi.signplus.config.SignplusConfig;
import com.alohi.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.signplus.getTemplate("template_id");

    System.out.println(response);
  }
}

​
deleteTemplate

Delete template

  • HTTP Method: DELETE
  • Endpoint: /template/{template_id}

Parameters

NameTypeRequiredDescription
templateIdString✅

Example Usage Code Snippet

import com.alohi.signplus.Signplus;
import com.alohi.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.signplus.deleteTemplate("template_id");
  }
}

​
duplicateTemplate

Duplicate template

  • HTTP Method: POST
  • Endpoint: /template/{template_id}/duplicate

Parameters

NameTypeRequiredDescription
templateIdString✅

Return Type

Template

Example Usage Code Snippet

import com.alohi.signplus.Signplus;
import com.alohi.signplus.config.SignplusConfig;
import com.alohi.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.signplus.duplicateTemplate("template_id");

    System.out.println(response);
  }
}

​
addTemplateDocument

Add template document

  • HTTP Method: POST
  • Endpoint: /template/{template_id}/document

Parameters

NameTypeRequiredDescription
templateIdString✅
addTemplateDocumentRequestAddTemplateDocumentRequest✅Request Body

Return Type

Document

Example Usage Code Snippet

import com.alohi.signplus.Signplus;
import com.alohi.signplus.config.SignplusConfig;
import com.alohi.signplus.models.AddTemplateDocumentRequest;
import com.alohi.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.signplus.addTemplateDocument("template_id", addTemplateDocumentRequest);

    System.out.println(response);
  }
}

​
getTemplateDocument

Get template document

  • HTTP Method: GET
  • Endpoint: /template/{template_id}/document/{document_id}

Parameters

NameTypeRequiredDescription
templateIdString✅
documentIdString✅

Return Type

Document

Example Usage Code Snippet

import com.alohi.signplus.Signplus;
import com.alohi.signplus.config.SignplusConfig;
import com.alohi.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.signplus.getTemplateDocument("template_id", "document_id");

    System.out.println(response);
  }
}

​
getTemplateDocuments

Get template documents

  • HTTP Method: GET
  • Endpoint: /template/{template_id}/documents

Parameters

NameTypeRequiredDescription
templateIdString✅

Return Type

ListTemplateDocumentsResponse

Example Usage Code Snippet

import com.alohi.signplus.Signplus;
import com.alohi.signplus.config.SignplusConfig;
import com.alohi.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.signplus.getTemplateDocuments("template_id");

    System.out.println(response);
  }
}

​
addTemplateSigningSteps

Add template signing steps

  • HTTP Method: POST
  • Endpoint: /template/{template_id}/signing_steps

Parameters

NameTypeRequiredDescription
templateIdString✅
addTemplateSigningStepsRequestAddTemplateSigningStepsRequest✅Request Body

Return Type

Template

Example Usage Code Snippet

import com.alohi.signplus.Signplus;
import com.alohi.signplus.config.SignplusConfig;
import com.alohi.signplus.models.AddTemplateSigningStepsRequest;
import com.alohi.signplus.models.Template;
import com.alohi.signplus.models.TemplateRecipient;
import com.alohi.signplus.models.TemplateRecipientRole;
import com.alohi.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.signplus.addTemplateSigningSteps("template_id", addTemplateSigningStepsRequest);

    System.out.println(response);
  }
}

​
renameTemplate

Rename template

  • HTTP Method: PUT
  • Endpoint: /template/{template_id}/rename

Parameters

NameTypeRequiredDescription
templateIdString✅
renameTemplateRequestRenameTemplateRequest✅Request Body

Return Type

Template

Example Usage Code Snippet

import com.alohi.signplus.Signplus;
import com.alohi.signplus.config.SignplusConfig;
import com.alohi.signplus.models.RenameTemplateRequest;
import com.alohi.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.signplus.renameTemplate("template_id", renameTemplateRequest);

    System.out.println(response);
  }
}

​
setTemplateComment

Set template comment

  • HTTP Method: PUT
  • Endpoint: /template/{template_id}/set_comment

Parameters

NameTypeRequiredDescription
templateIdString✅
setTemplateCommentRequestSetTemplateCommentRequest✅Request Body

Return Type

Template

Example Usage Code Snippet

import com.alohi.signplus.Signplus;
import com.alohi.signplus.config.SignplusConfig;
import com.alohi.signplus.models.SetTemplateCommentRequest;
import com.alohi.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.signplus.setTemplateComment("template_id", setTemplateCommentRequest);

    System.out.println(response);
  }
}

​
setTemplateNotification

Set template notification

  • HTTP Method: PUT
  • Endpoint: /template/{template_id}/set_notification

Parameters

NameTypeRequiredDescription
templateIdString✅
envelopeNotificationEnvelopeNotification✅Request Body

Return Type

Template

Example Usage Code Snippet

import com.alohi.signplus.Signplus;
import com.alohi.signplus.config.SignplusConfig;
import com.alohi.signplus.models.EnvelopeNotification;
import com.alohi.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.signplus.setTemplateNotification("template_id", envelopeNotification);

    System.out.println(response);
  }
}

​
getTemplateAnnotations

Get template annotations

  • HTTP Method: GET
  • Endpoint: /template/{template_id}/annotations

Parameters

NameTypeRequiredDescription
templateIdString✅ID of the template

Return Type

ListTemplateAnnotationsResponse

Example Usage Code Snippet

import com.alohi.signplus.Signplus;
import com.alohi.signplus.config.SignplusConfig;
import com.alohi.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.signplus.getTemplateAnnotations("template_id");

    System.out.println(response);
  }
}

​
getDocumentTemplateAnnotations

Get document template annotations

  • HTTP Method: GET
  • Endpoint: /template/{template_id}/annotations/{document_id}

Parameters

NameTypeRequiredDescription
templateIdString✅ID of the template
documentIdString✅ID of document

Return Type

ListTemplateDocumentAnnotationsResponse

Example Usage Code Snippet

import com.alohi.signplus.Signplus;
import com.alohi.signplus.config.SignplusConfig;
import com.alohi.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.signplus.getDocumentTemplateAnnotations(
      "template_id",
      "document_id"
    );

    System.out.println(response);
  }
}

​
addTemplateAnnotation

Add template annotation

  • HTTP Method: POST
  • Endpoint: /template/{template_id}/annotation

Parameters

NameTypeRequiredDescription
templateIdString✅ID of the template
addAnnotationRequestAddAnnotationRequest✅Request Body

Return Type

Annotation

Example Usage Code Snippet

import com.alohi.signplus.Signplus;
import com.alohi.signplus.config.SignplusConfig;
import com.alohi.signplus.models.AddAnnotationRequest;
import com.alohi.signplus.models.Annotation;
import com.alohi.signplus.models.AnnotationCheckbox;
import com.alohi.signplus.models.AnnotationCheckboxStyle;
import com.alohi.signplus.models.AnnotationDateTime;
import com.alohi.signplus.models.AnnotationDateTimeFormat;
import com.alohi.signplus.models.AnnotationFont;
import com.alohi.signplus.models.AnnotationFontFamily;
import com.alohi.signplus.models.AnnotationInitials;
import com.alohi.signplus.models.AnnotationSignature;
import com.alohi.signplus.models.AnnotationText;
import com.alohi.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(false)
      .build();

    AnnotationText annotationText = AnnotationText
      .builder()
      .size(1.49D)
      .color(1.36D)
      .value("value")
      .tooltip("tooltip")
      .dynamicFieldName("dynamic_field_name")
      .font(annotationFont)
      .build();

    AnnotationDateTime annotationDateTime = AnnotationDateTime
      .builder()
      .size(8.29D)
      .font(annotationFont)
      .color("color")
      .autoFill(false)
      .timezone("timezone")
      .timestamp(2L)
      .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(1L)
      .x(8.95D)
      .y(1.39D)
      .width(2.77D)
      .height(6.96D)
      .required(false)
      .type(AnnotationType.TEXT)
      .signature(annotationSignature)
      .initials(annotationInitials)
      .text(annotationText)
      .datetime(annotationDateTime)
      .checkbox(annotationCheckbox)
      .build();

    Annotation response = signplus.signplus.addTemplateAnnotation("template_id", addAnnotationRequest);

    System.out.println(response);
  }
}

​
deleteTemplateAnnotation

Delete template annotation

  • HTTP Method: DELETE
  • Endpoint: /template/{template_id}/annotation/{annotation_id}

Parameters

NameTypeRequiredDescription
templateIdString✅ID of the template
annotationIdString✅ID of the annotation to delete

Example Usage Code Snippet

import com.alohi.signplus.Signplus;
import com.alohi.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.signplus.deleteTemplateAnnotation("template_id", "annotation_id");
  }
}

​
createWebhook

Create webhook

  • HTTP Method: POST
  • Endpoint: /webhook

Parameters

NameTypeRequiredDescription
createWebhookRequestCreateWebhookRequest✅Request Body

Return Type

Webhook

Example Usage Code Snippet

import com.alohi.signplus.Signplus;
import com.alohi.signplus.config.SignplusConfig;
import com.alohi.signplus.models.CreateWebhookRequest;
import com.alohi.signplus.models.Webhook;
import com.alohi.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.signplus.createWebhook(createWebhookRequest);

    System.out.println(response);
  }
}

​
listWebhooks

List webhooks

  • HTTP Method: POST
  • Endpoint: /webhooks

Parameters

NameTypeRequiredDescription
listWebhooksRequestListWebhooksRequest❌Request Body

Return Type

ListWebhooksResponse

Example Usage Code Snippet

import com.alohi.signplus.Signplus;
import com.alohi.signplus.config.SignplusConfig;
import com.alohi.signplus.models.ListWebhooksRequest;
import com.alohi.signplus.models.ListWebhooksResponse;
import com.alohi.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.signplus.listWebhooks(listWebhooksRequest);

    System.out.println(response);
  }
}

​
deleteWebhook

Delete webhook

  • HTTP Method: DELETE
  • Endpoint: /webhook/{webhook_id}

Parameters

NameTypeRequiredDescription
webhookIdString✅

Example Usage Code Snippet

import com.alohi.signplus.Signplus;
import com.alohi.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.signplus.deleteWebhook("webhook_id");
  }
}

​
Models

​
Document

Properties

NameTypeRequiredDescription
idString❌Unique identifier of the document
nameString❌Name of the document
filenameString❌Filename of the document
pageCountLong❌Number of pages in the document
pagesList&lt;Page&gt;❌List of pages in the document

​
CreateEnvelopeRequest

Properties

NameTypeRequiredDescription
nameString✅Name of the envelope
legalityLevelEnvelopeLegalityLevel✅Legal level of the envelope (SES is Simple Electronic Signature, QES_EIDAS is Qualified Electronic Signature, QES_ZERTES is Qualified Electronic Signature with Zertes)
expiresAtLong❌Unix timestamp of the expiration date
commentString❌Comment for the envelope
sandboxBoolean❌Whether the envelope is created in sandbox mode

​
ListEnvelopesRequest

Properties

NameTypeRequiredDescription
nameString❌Name of the envelope
tagsList&lt;String&gt;❌List of tags
commentString❌Comment of the envelope
idsList&lt;String&gt;❌List of envelope IDs
statusesList&lt;EnvelopeStatus&gt;❌List of envelope statuses
folderIdsList&lt;String&gt;❌List of folder IDs
onlyRootFolderBoolean❌Whether to only list envelopes in the root folder
dateFromLong❌Unix timestamp of the start date
dateToLong❌Unix timestamp of the end date
uidString❌Unique identifier of the user
firstLong❌
lastLong❌
afterString❌
beforeString❌
orderFieldEnvelopeOrderField❌Field to order envelopes by
ascendingBoolean❌Whether to order envelopes in ascending order
includeTrashBoolean❌Whether to include envelopes in the trash

​
EnvelopeNotification

Properties

NameTypeRequiredDescription
subjectString❌Subject of the notification
messageString❌Message of the notification
reminderIntervalLong❌Interval in days to send reminder

​
ListTemplatesRequest

Properties

NameTypeRequiredDescription
nameString❌Name of the template
tagsList&lt;String&gt;❌List of tag templates
idsList&lt;String&gt;❌List of templates IDs
firstLong❌
lastLong❌
afterString❌
beforeString❌
orderFieldTemplateOrderField❌Field to order templates by
ascendingBoolean❌Whether to order templates in ascending order

​
SetTemplateCommentRequest

Properties

NameTypeRequiredDescription
commentString✅Comment for the template

​
Template

Properties

NameTypeRequiredDescription
idString❌Unique identifier of the template
nameString❌Name of the template
commentString❌Comment for the template
pagesLong❌Total number of pages in the template
legalityLevelEnvelopeLegalityLevel❌Legal level of the envelope (SES is Simple Electronic Signature, QES_EIDAS is Qualified Electronic Signature, QES_ZERTES is Qualified Electronic Signature with Zertes)
createdAtLong❌Unix timestamp of the creation date
updatedAtLong❌Unix timestamp of the last modification date
expirationDelayLong❌Expiration delay added to the current time when an envelope is created from this template
numRecipientsLong❌Number of recipients in the envelope
signingStepsList&lt;TemplateSigningStep&gt;❌
documentsList&lt;Document&gt;❌
notificationEnvelopeNotification❌
dynamicFieldsList&lt;String&gt;❌List of dynamic fields

​
RecipientVerificationType

Type of signature verification (SMS sends a code via SMS, PASSCODE requires a code to be entered)

Properties

NameTypeRequiredDescription
SMSString✅“SMS”
PASSCODEString✅“PASSCODE”

​
AddEnvelopeSigningStepsRequest

Properties

NameTypeRequiredDescription
signingStepsList&lt;SigningStep&gt;❌List of signing steps

​
AnnotationFontFamily

Font family of the text

Properties

NameTypeRequiredDescription
UNKNOWNString✅“UNKNOWN”
SERIFString✅“SERIF”
SANSString✅“SANS”
MONOString✅“MONO”

​
AddTemplateSigningStepsRequest

Properties

NameTypeRequiredDescription
signingStepsList&lt;TemplateSigningStep&gt;✅List of signing steps

​
SetEnvelopeCommentRequest

Properties

NameTypeRequiredDescription
commentString✅Comment for the envelope

​
TemplateOrderField

Field to order templates by

Properties

NameTypeRequiredDescription
TEMPLATE_IDString✅“TEMPLATE_ID”
TEMPLATE_CREATION_DATEString✅“TEMPLATE_CREATION_DATE”
TEMPLATE_MODIFICATION_DATEString✅“TEMPLATE_MODIFICATION_DATE”
TEMPLATE_NAMEString✅“TEMPLATE_NAME”

​
EnvelopeOrderField

Field to order envelopes by

Properties

NameTypeRequiredDescription
CREATION_DATEString✅“CREATION_DATE”
MODIFICATION_DATEString✅“MODIFICATION_DATE”
NAMEString✅“NAME”
STATUSString✅“STATUS”
LAST_DOCUMENT_CHANGEString✅“LAST_DOCUMENT_CHANGE”

​
AddEnvelopeDocumentRequest

Properties

NameTypeRequiredDescription
filebyte[]❌File to upload in binary format

​
ListWebhooksRequest

Properties

NameTypeRequiredDescription
webhookIdString❌ID of the webhook
eventWebhookEvent❌Event of the webhook

​
SetEnvelopeLegalityLevelRequest

Properties

NameTypeRequiredDescription
legalityLevelEnvelopeLegalityLevel❌Legal level of the envelope (SES is Simple Electronic Signature, QES_EIDAS is Qualified Electronic Signature, QES_ZERTES is Qualified Electronic Signature with Zertes)

​
SetEnvelopeExpirationRequest

Properties

NameTypeRequiredDescription
expiresAtLong✅Unix timestamp of the expiration date

​
AnnotationText

Text annotation (null if annotation is not a text)

Properties

NameTypeRequiredDescription
sizeDouble❌Font size of the text in pt
colorDouble❌Text color in 32bit representation
valueString❌Text content of the annotation
tooltipString❌Tooltip of the annotation
dynamicFieldNameString❌Name of the dynamic field
fontAnnotationFont❌

​
AnnotationCheckbox

Checkbox annotation (null if annotation is not a checkbox)

Properties

NameTypeRequiredDescription
checkedBoolean❌Whether the checkbox is checked
styleAnnotationCheckboxStyle❌Style of the checkbox

​
Envelope

Properties

NameTypeRequiredDescription
idString❌Unique identifier of the envelope
nameString❌Name of the envelope
commentString❌Comment for the envelope
pagesLong❌Total number of pages in the envelope
flowTypeEnvelopeFlowType❌Flow type of the envelope (REQUEST_SIGNATURE is a request for signature, SIGN_MYSELF is a self-signing flow)
legalityLevelEnvelopeLegalityLevel❌Legal level of the envelope (SES is Simple Electronic Signature, QES_EIDAS is Qualified Electronic Signature, QES_ZERTES is Qualified Electronic Signature with Zertes)
statusEnvelopeStatus❌Status of the envelope
createdAtLong❌Unix timestamp of the creation date
updatedAtLong❌Unix timestamp of the last modification date
expiresAtLong❌Unix timestamp of the expiration date
numRecipientsLong❌Number of recipients in the envelope
isDuplicableBoolean❌Whether the envelope can be duplicated
signingStepsList&lt;SigningStep&gt;❌
documentsList&lt;Document&gt;❌
notificationEnvelopeNotification❌

​
AddTemplateDocumentRequest

Properties

NameTypeRequiredDescription
filebyte[]✅File to upload in binary format

​
TemplateRecipient

Properties

NameTypeRequiredDescription
idString❌Unique identifier of the recipient
uidString❌Unique identifier of the user associated with the recipient
nameString❌Name of the recipient
emailString❌Email of the recipient
roleTemplateRecipientRole❌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)

​
AddAnnotationRequest

Properties

NameTypeRequiredDescription
documentIdString✅ID of the document
pageLong✅Page number where the annotation is placed
xDouble✅X coordinate of the annotation (in % of the page width from 0 to 100) from the top left corner
yDouble✅Y coordinate of the annotation (in % of the page height from 0 to 100) from the top left corner
widthDouble✅Width of the annotation (in % of the page width from 0 to 100)
heightDouble✅Height of the annotation (in % of the page height from 0 to 100)
typeAnnotationType✅Type of the annotation
recipientIdString❌ID of the recipient
requiredBoolean❌
signatureAnnotationSignature❌Signature annotation (null if annotation is not a signature)
initialsAnnotationInitials❌Initials annotation (null if annotation is not initials)
textAnnotationText❌Text annotation (null if annotation is not a text)
datetimeAnnotationDateTime❌Date annotation (null if annotation is not a date)
checkboxAnnotationCheckbox❌Checkbox annotation (null if annotation is not a checkbox)

​
ListEnvelopeDocumentAnnotationsResponse

Properties

NameTypeRequiredDescription
annotationsList&lt;Annotation&gt;❌

​
EnvelopeStatus

Status of the envelope

Properties

NameTypeRequiredDescription
DRAFTString✅“DRAFT”
IN_PROGRESSString✅“IN_PROGRESS”
COMPLETEDString✅“COMPLETED”
EXPIREDString✅“EXPIRED”
DECLINEDString✅“DECLINED”
VOIDEDString✅“VOIDED”
PENDINGString✅“PENDING”

​
RecipientVerification

Properties

NameTypeRequiredDescription
typeRecipientVerificationType❌Type of signature verification (SMS sends a code via SMS, PASSCODE requires a code to be entered)
valueString❌

​
AnnotationCheckboxStyle

Style of the checkbox

Properties

NameTypeRequiredDescription
CIRCLE_CHECKString✅“CIRCLE_CHECK”
CIRCLE_FULLString✅“CIRCLE_FULL”
SQUARE_CHECKString✅“SQUARE_CHECK”
SQUARE_FULLString✅“SQUARE_FULL”
CHECK_MARKString✅“CHECK_MARK”
TIMES_SQUAREString✅“TIMES_SQUARE”

​
SigningStep

Properties

NameTypeRequiredDescription
recipientsList&lt;Recipient&gt;❌List of recipients

​
AnnotationDateTime

Date annotation (null if annotation is not a date)

Properties

NameTypeRequiredDescription
sizeDouble❌Font size of the text in pt
fontAnnotationFont❌
colorString❌Color of the text in hex format
autoFillBoolean❌Whether the date should be automatically filled
timezoneString❌Timezone of the date
timestampLong❌Unix timestamp of the date
formatAnnotationDateTimeFormat❌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)

​
CreateTemplateRequest

Properties

NameTypeRequiredDescription
nameString✅

​
ListTemplateDocumentsResponse

Properties

NameTypeRequiredDescription
documentsList&lt;Document&gt;❌

​
AnnotationInitials

Initials annotation (null if annotation is not initials)

Properties

NameTypeRequiredDescription
idString❌Unique identifier of the annotation initials

​
AnnotationFont

Properties

NameTypeRequiredDescription
familyAnnotationFontFamily❌Font family of the text
italicBoolean❌Whether the text is italic
boldBoolean❌Whether the text is bold

​
AnnotationType

Type of the annotation

Properties

NameTypeRequiredDescription
TEXTString✅“TEXT”
SIGNATUREString✅“SIGNATURE”
INITIALSString✅“INITIALS”
CHECKBOXString✅“CHECKBOX”
DATEString✅“DATE”

​
Webhook

Properties

NameTypeRequiredDescription
idString❌Unique identifier of the webhook
eventWebhookEvent❌Event of the webhook
targetString❌Target URL of the webhook

​
RenameTemplateRequest

Properties

NameTypeRequiredDescription
nameString✅Name of the template

​
ListTemplatesResponse

Properties

NameTypeRequiredDescription
hasNextPageBoolean❌Whether there is a next page
hasPreviousPageBoolean❌Whether there is a previous page
templatesList&lt;Template&gt;❌

​
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

NameTypeRequiredDescription
SIGNERString✅“SIGNER”
RECEIVES_COPYString✅“RECEIVES_COPY”
IN_PERSON_SIGNERString✅“IN_PERSON_SIGNER”

​
Annotation

Properties

NameTypeRequiredDescription
idString❌Unique identifier of the annotation
recipientIdString❌ID of the recipient
documentIdString❌ID of the document
pageLong❌Page number where the annotation is placed
xDouble❌X coordinate of the annotation (in % of the page width from 0 to 100) from the top left corner
yDouble❌Y coordinate of the annotation (in % of the page height from 0 to 100) from the top left corner
widthDouble❌Width of the annotation (in % of the page width from 0 to 100)
heightDouble❌Height of the annotation (in % of the page height from 0 to 100)
requiredBoolean❌Whether the annotation is required
typeAnnotationType❌Type of the annotation
signatureAnnotationSignature❌Signature annotation (null if annotation is not a signature)
initialsAnnotationInitials❌Initials annotation (null if annotation is not initials)
textAnnotationText❌Text annotation (null if annotation is not a text)
datetimeAnnotationDateTime❌Date annotation (null if annotation is not a date)
checkboxAnnotationCheckbox❌Checkbox annotation (null if annotation is not a checkbox)

​
DynamicField

Properties

NameTypeRequiredDescription
nameString❌Name of the dynamic field
valueString❌Value of the dynamic field

​
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

NameTypeRequiredDescription
DMY_NUMERIC_SLASHString✅“DMY_NUMERIC_SLASH”
MDY_NUMERIC_SLASHString✅“MDY_NUMERIC_SLASH”
YMD_NUMERIC_SLASHString✅“YMD_NUMERIC_SLASH”
DMY_NUMERIC_DASH_SHORTString✅“DMY_NUMERIC_DASH_SHORT”
DMY_NUMERIC_DASHString✅“DMY_NUMERIC_DASH”
YMD_NUMERIC_DASHString✅“YMD_NUMERIC_DASH”
MDY_TEXT_DASH_SHORTString✅“MDY_TEXT_DASH_SHORT”
MDY_TEXT_SPACE_SHORTString✅“MDY_TEXT_SPACE_SHORT”
MDY_TEXT_SPACEString✅“MDY_TEXT_SPACE”

​
EnvelopeFlowType

Flow type of the envelope (REQUEST_SIGNATURE is a request for signature, SIGN_MYSELF is a self-signing flow)

Properties

NameTypeRequiredDescription
REQUEST_SIGNATUREString✅“REQUEST_SIGNATURE”
SIGN_MYSELFString✅“SIGN_MYSELF”

​
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

NameTypeRequiredDescription
SESString✅“SES”
QES_EIDASString✅“QES_EIDAS”
QES_ZERTESString✅“QES_ZERTES”

​
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

NameTypeRequiredDescription
SIGNERString✅“SIGNER”
RECEIVES_COPYString✅“RECEIVES_COPY”
IN_PERSON_SIGNERString✅“IN_PERSON_SIGNER”

​
SetEnvelopeDynamicFieldsRequest

Properties

NameTypeRequiredDescription
dynamicFieldsList&lt;DynamicField&gt;✅List of dynamic fields

​
Page

Properties

NameTypeRequiredDescription
widthLong❌Width of the page in pixels
heightLong❌Height of the page in pixels

​
TemplateSigningStep

Properties

NameTypeRequiredDescription
recipientsList&lt;TemplateRecipient&gt;❌List of recipients

​
ListEnvelopesResponse

Properties

NameTypeRequiredDescription
hasNextPageBoolean❌Whether there is a next page
hasPreviousPageBoolean❌Whether there is a previous page
envelopesList&lt;Envelope&gt;❌

​
Recipient

Properties

NameTypeRequiredDescription
nameString✅Name of the recipient
emailString✅Email of the recipient
roleRecipientRole✅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)
idString❌Unique identifier of the recipient
uidString❌Unique identifier of the user associated with the recipient
verificationRecipientVerification❌

​
WebhookEvent

Event of the webhook

Properties

NameTypeRequiredDescription
ENVELOPE_EXPIREDString✅“ENVELOPE_EXPIRED”
ENVELOPE_DECLINEDString✅“ENVELOPE_DECLINED”
ENVELOPE_VOIDEDString✅“ENVELOPE_VOIDED”
ENVELOPE_COMPLETEDString✅“ENVELOPE_COMPLETED”
ENVELOPE_AUDIT_TRAILString✅“ENVELOPE_AUDIT_TRAIL”

​
CreateWebhookRequest

Properties

NameTypeRequiredDescription
eventWebhookEvent✅Event of the webhook
targetString✅URL of the webhook target

​
CreateEnvelopeFromTemplateRequest

Properties

NameTypeRequiredDescription
nameString✅Name of the envelope
commentString❌Comment for the envelope
sandboxBoolean❌Whether the envelope is created in sandbox mode

​
ListTemplateAnnotationsResponse

Properties

NameTypeRequiredDescription
annotationsList&lt;Annotation&gt;❌

​
RenameEnvelopeRequest

Properties

NameTypeRequiredDescription
nameString❌Name of the envelope

​
ListTemplateDocumentAnnotationsResponse

Properties

NameTypeRequiredDescription
annotationsList&lt;Annotation&gt;❌

​
ListEnvelopeDocumentsResponse

Properties

NameTypeRequiredDescription
documentsList&lt;Document&gt;❌

​
ListWebhooksResponse

Properties

NameTypeRequiredDescription
webhooksList&lt;Webhook&gt;❌

​
AnnotationSignature

Signature annotation (null if annotation is not a signature)

Properties

NameTypeRequiredDescription
idString❌Unique identifier of the annotation signature
InstallInstall