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

MethodsDescription
CreateEnvelopeAsyncCreate new envelope
CreateEnvelopeFromTemplateAsyncCreate new envelope from template
ListEnvelopesAsyncList envelopes
GetEnvelopeAsyncGet envelope
DeleteEnvelopeAsyncDelete envelope
GetEnvelopeDocumentAsyncGet envelope document
GetEnvelopeDocumentsAsyncGet envelope documents
AddEnvelopeDocumentAsyncAdd envelope document
SetEnvelopeDynamicFieldsAsyncSet envelope dynamic fields
AddEnvelopeSigningStepsAsyncAdd envelope signing steps
SendEnvelopeAsyncSend envelope for signature
DuplicateEnvelopeAsyncDuplicate envelope
VoidEnvelopeAsyncVoid envelope
RenameEnvelopeAsyncRename envelope
SetEnvelopeCommentAsyncSet envelope comment
SetEnvelopeNotificationAsyncSet envelope notification
SetEnvelopeExpirationDateAsyncSet envelope expiration date
SetEnvelopeLegalityLevelAsyncSet envelope legality level
GetEnvelopeAnnotationsAsyncGet envelope annotations
GetEnvelopeDocumentAnnotationsAsyncGet envelope document annotations
AddEnvelopeAnnotationAsyncAdd envelope annotation
DeleteEnvelopeAnnotationAsyncDelete envelope annotation
CreateTemplateAsyncCreate new template
ListTemplatesAsyncList templates
GetTemplateAsyncGet template
DeleteTemplateAsyncDelete template
DuplicateTemplateAsyncDuplicate template
AddTemplateDocumentAsyncAdd template document
GetTemplateDocumentAsyncGet template document
GetTemplateDocumentsAsyncGet template documents
AddTemplateSigningStepsAsyncAdd template signing steps
RenameTemplateAsyncRename template
SetTemplateCommentAsyncSet template comment
SetTemplateNotificationAsyncSet template notification
GetTemplateAnnotationsAsyncGet template annotations
GetDocumentTemplateAnnotationsAsyncGet document template annotations
AddTemplateAnnotationAsyncAdd template annotation
DeleteTemplateAnnotationAsyncDelete template annotation
CreateWebhookAsyncCreate webhook
ListWebhooksAsyncList webhooks
DeleteWebhookAsyncDelete webhook

​
CreateEnvelopeAsync

Create new envelope

  • HTTP Method: POST
  • Endpoint: /envelope

Parameters

NameTypeRequiredDescription
inputCreateEnvelopeRequest✅The request body.

Return Type

Envelope

Example Usage Code Snippet

using Alohi.Signplus;
using Alohi.Signplus.Config;
using Alohi.Signplus.Models;
using Environment = Alohi.Signplus.Http.Environment;

var config = new SignplusConfig{
    Environment = Environment.Default
};

var client = new SignplusClient(config);

var input = new CreateEnvelopeRequest("name", EnvelopeLegalityLevel.Ses, 2, "comment", true);

var response = await client.Signplus.CreateEnvelopeAsync(input);

Console.WriteLine(response);

​
CreateEnvelopeFromTemplateAsync

Create new envelope from template

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

Parameters

NameTypeRequiredDescription
inputCreateEnvelopeFromTemplateRequest✅The request body.
templateIdstring✅

Return Type

Envelope

Example Usage Code Snippet

using Alohi.Signplus;
using Alohi.Signplus.Config;
using Alohi.Signplus.Models;
using Environment = Alohi.Signplus.Http.Environment;

var config = new SignplusConfig{
    Environment = Environment.Default
};

var client = new SignplusClient(config);

var input = new CreateEnvelopeFromTemplateRequest("name", "comment", true);

var response = await client.Signplus.CreateEnvelopeFromTemplateAsync(input, "template_id");

Console.WriteLine(response);

​
ListEnvelopesAsync

List envelopes

  • HTTP Method: POST
  • Endpoint: /envelopes

Parameters

NameTypeRequiredDescription
inputListEnvelopesRequest❌The request body.

Return Type

ListEnvelopesResponse

Example Usage Code Snippet

using Alohi.Signplus;
using Alohi.Signplus.Config;
using Alohi.Signplus.Models;
using Environment = Alohi.Signplus.Http.Environment;

var config = new SignplusConfig{
    Environment = Environment.Default
};

var client = new SignplusClient(config);

var tags = new List<string>() { "tags" };
var ids = new List<string>() { "ids" };
var statuses = new List<EnvelopeStatus>() { EnvelopeStatus.Draft };
var folderIds = new List<string>() { "folder_ids" };
var input = new ListEnvelopesRequest("name", tags, "comment", ids, statuses, folderIds, false, 5, 0, "uid", 10, 8, "after", "before", EnvelopeOrderField.CreationDate, false, true);

var response = await client.Signplus.ListEnvelopesAsync(input);

Console.WriteLine(response);

​
GetEnvelopeAsync

Get envelope

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

Parameters

NameTypeRequiredDescription
envelopeIdstring✅

Return Type

Envelope

Example Usage Code Snippet

using Alohi.Signplus;
using Alohi.Signplus.Config;
using Environment = Alohi.Signplus.Http.Environment;

var config = new SignplusConfig{
    Environment = Environment.Default
};

var client = new SignplusClient(config);

var response = await client.Signplus.GetEnvelopeAsync("envelope_id");

Console.WriteLine(response);

​
DeleteEnvelopeAsync

Delete envelope

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

Parameters

NameTypeRequiredDescription
envelopeIdstring✅

Example Usage Code Snippet

using Alohi.Signplus;
using Alohi.Signplus.Config;
using Environment = Alohi.Signplus.Http.Environment;

var config = new SignplusConfig{
    Environment = Environment.Default
};

var client = new SignplusClient(config);

await client.Signplus.DeleteEnvelopeAsync("envelope_id");

​
GetEnvelopeDocumentAsync

Get envelope document

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

Parameters

NameTypeRequiredDescription
envelopeIdstring✅
documentIdstring✅

Return Type

Document

Example Usage Code Snippet

using Alohi.Signplus;
using Alohi.Signplus.Config;
using Environment = Alohi.Signplus.Http.Environment;

var config = new SignplusConfig{
    Environment = Environment.Default
};

var client = new SignplusClient(config);

var response = await client.Signplus.GetEnvelopeDocumentAsync("envelope_id", "document_id");

Console.WriteLine(response);

​
GetEnvelopeDocumentsAsync

Get envelope documents

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

Parameters

NameTypeRequiredDescription
envelopeIdstring✅

Return Type

ListEnvelopeDocumentsResponse

Example Usage Code Snippet

using Alohi.Signplus;
using Alohi.Signplus.Config;
using Environment = Alohi.Signplus.Http.Environment;

var config = new SignplusConfig{
    Environment = Environment.Default
};

var client = new SignplusClient(config);

var response = await client.Signplus.GetEnvelopeDocumentsAsync("envelope_id");

Console.WriteLine(response);

​
AddEnvelopeDocumentAsync

Add envelope document

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

Parameters

NameTypeRequiredDescription
inputAddEnvelopeDocumentRequest✅The request body.
envelopeIdstring✅

Return Type

Document

Example Usage Code Snippet

using Alohi.Signplus;
using Alohi.Signplus.Config;
using Alohi.Signplus.Models;
using Environment = Alohi.Signplus.Http.Environment;

var config = new SignplusConfig{
    Environment = Environment.Default
};

var client = new SignplusClient(config);

var input = new AddEnvelopeDocumentRequest(new byte[] {});

var response = await client.Signplus.AddEnvelopeDocumentAsync(input, "envelope_id");

Console.WriteLine(response);

​
SetEnvelopeDynamicFieldsAsync

Set envelope dynamic fields

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

Parameters

NameTypeRequiredDescription
inputSetEnvelopeDynamicFieldsRequest✅The request body.
envelopeIdstring✅

Return Type

Envelope

Example Usage Code Snippet

using Alohi.Signplus;
using Alohi.Signplus.Config;
using Alohi.Signplus.Models;
using Environment = Alohi.Signplus.Http.Environment;

var config = new SignplusConfig{
    Environment = Environment.Default
};

var client = new SignplusClient(config);

var dynamicFieldsItem = new DynamicField("name", "value");
var dynamicFields = new List<DynamicField>() { dynamicFieldsItem };
var input = new SetEnvelopeDynamicFieldsRequest(dynamicFields);

var response = await client.Signplus.SetEnvelopeDynamicFieldsAsync(input, "envelope_id");

Console.WriteLine(response);

​
AddEnvelopeSigningStepsAsync

Add envelope signing steps

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

Parameters

NameTypeRequiredDescription
inputAddEnvelopeSigningStepsRequest✅The request body.
envelopeIdstring✅

Return Type

Envelope

Example Usage Code Snippet

using Alohi.Signplus;
using Alohi.Signplus.Config;
using Alohi.Signplus.Models;
using Environment = Alohi.Signplus.Http.Environment;

var config = new SignplusConfig{
    Environment = Environment.Default
};

var client = new SignplusClient(config);

var verification = new RecipientVerification(RecipientVerificationType.Sms, "value");
var recipientsItem = new Recipient("name", "email", RecipientRole.Signer, "id", "uid", verification);
var recipients = new List<Recipient>() { recipientsItem };
var signingStepsItem = new SigningStep(recipients);
var signingSteps = new List<SigningStep>() { signingStepsItem };
var input = new AddEnvelopeSigningStepsRequest(signingSteps);

var response = await client.Signplus.AddEnvelopeSigningStepsAsync(input, "envelope_id");

Console.WriteLine(response);

​
SendEnvelopeAsync

Send envelope for signature

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

Parameters

NameTypeRequiredDescription
envelopeIdstring✅

Return Type

Envelope

Example Usage Code Snippet

using Alohi.Signplus;
using Alohi.Signplus.Config;
using Environment = Alohi.Signplus.Http.Environment;

var config = new SignplusConfig{
    Environment = Environment.Default
};

var client = new SignplusClient(config);

var response = await client.Signplus.SendEnvelopeAsync("envelope_id");

Console.WriteLine(response);

​
DuplicateEnvelopeAsync

Duplicate envelope

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

Parameters

NameTypeRequiredDescription
envelopeIdstring✅

Return Type

Envelope

Example Usage Code Snippet

using Alohi.Signplus;
using Alohi.Signplus.Config;
using Environment = Alohi.Signplus.Http.Environment;

var config = new SignplusConfig{
    Environment = Environment.Default
};

var client = new SignplusClient(config);

var response = await client.Signplus.DuplicateEnvelopeAsync("envelope_id");

Console.WriteLine(response);

​
VoidEnvelopeAsync

Void envelope

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

Parameters

NameTypeRequiredDescription
envelopeIdstring✅

Return Type

Envelope

Example Usage Code Snippet

using Alohi.Signplus;
using Alohi.Signplus.Config;
using Environment = Alohi.Signplus.Http.Environment;

var config = new SignplusConfig{
    Environment = Environment.Default
};

var client = new SignplusClient(config);

var response = await client.Signplus.VoidEnvelopeAsync("envelope_id");

Console.WriteLine(response);

​
RenameEnvelopeAsync

Rename envelope

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

Parameters

NameTypeRequiredDescription
inputRenameEnvelopeRequest✅The request body.
envelopeIdstring✅

Return Type

Envelope

Example Usage Code Snippet

using Alohi.Signplus;
using Alohi.Signplus.Config;
using Alohi.Signplus.Models;
using Environment = Alohi.Signplus.Http.Environment;

var config = new SignplusConfig{
    Environment = Environment.Default
};

var client = new SignplusClient(config);

var input = new RenameEnvelopeRequest("name");

var response = await client.Signplus.RenameEnvelopeAsync(input, "envelope_id");

Console.WriteLine(response);

​
SetEnvelopeCommentAsync

Set envelope comment

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

Parameters

NameTypeRequiredDescription
inputSetEnvelopeCommentRequest✅The request body.
envelopeIdstring✅

Return Type

Envelope

Example Usage Code Snippet

using Alohi.Signplus;
using Alohi.Signplus.Config;
using Alohi.Signplus.Models;
using Environment = Alohi.Signplus.Http.Environment;

var config = new SignplusConfig{
    Environment = Environment.Default
};

var client = new SignplusClient(config);

var input = new SetEnvelopeCommentRequest("comment");

var response = await client.Signplus.SetEnvelopeCommentAsync(input, "envelope_id");

Console.WriteLine(response);

​
SetEnvelopeNotificationAsync

Set envelope notification

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

Parameters

NameTypeRequiredDescription
inputEnvelopeNotification✅The request body.
envelopeIdstring✅

Return Type

Envelope

Example Usage Code Snippet

using Alohi.Signplus;
using Alohi.Signplus.Config;
using Alohi.Signplus.Models;
using Environment = Alohi.Signplus.Http.Environment;

var config = new SignplusConfig{
    Environment = Environment.Default
};

var client = new SignplusClient(config);

var input = new EnvelopeNotification("subject", "message", 10);

var response = await client.Signplus.SetEnvelopeNotificationAsync(input, "envelope_id");

Console.WriteLine(response);

​
SetEnvelopeExpirationDateAsync

Set envelope expiration date

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

Parameters

NameTypeRequiredDescription
inputSetEnvelopeExpirationRequest✅The request body.
envelopeIdstring✅

Return Type

Envelope

Example Usage Code Snippet

using Alohi.Signplus;
using Alohi.Signplus.Config;
using Alohi.Signplus.Models;
using Environment = Alohi.Signplus.Http.Environment;

var config = new SignplusConfig{
    Environment = Environment.Default
};

var client = new SignplusClient(config);

var input = new SetEnvelopeExpirationRequest(0);

var response = await client.Signplus.SetEnvelopeExpirationDateAsync(input, "envelope_id");

Console.WriteLine(response);

​
SetEnvelopeLegalityLevelAsync

Set envelope legality level

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

Parameters

NameTypeRequiredDescription
inputSetEnvelopeLegalityLevelRequest✅The request body.
envelopeIdstring✅

Return Type

Envelope

Example Usage Code Snippet

using Alohi.Signplus;
using Alohi.Signplus.Config;
using Alohi.Signplus.Models;
using Environment = Alohi.Signplus.Http.Environment;

var config = new SignplusConfig{
    Environment = Environment.Default
};

var client = new SignplusClient(config);

var input = new SetEnvelopeLegalityLevelRequest(EnvelopeLegalityLevel.Ses);

var response = await client.Signplus.SetEnvelopeLegalityLevelAsync(input, "envelope_id");

Console.WriteLine(response);

​
GetEnvelopeAnnotationsAsync

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

using Alohi.Signplus;
using Alohi.Signplus.Config;
using Environment = Alohi.Signplus.Http.Environment;

var config = new SignplusConfig{
    Environment = Environment.Default
};

var client = new SignplusClient(config);

var response = await client.Signplus.GetEnvelopeAnnotationsAsync("envelope_id");

Console.WriteLine(response);

​
GetEnvelopeDocumentAnnotationsAsync

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

using Alohi.Signplus;
using Alohi.Signplus.Config;
using Environment = Alohi.Signplus.Http.Environment;

var config = new SignplusConfig{
    Environment = Environment.Default
};

var client = new SignplusClient(config);

var response = await client.Signplus.GetEnvelopeDocumentAnnotationsAsync("envelope_id", "document_id");

Console.WriteLine(response);

​
AddEnvelopeAnnotationAsync

Add envelope annotation

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

Parameters

NameTypeRequiredDescription
inputAddAnnotationRequest✅The request body.
envelopeIdstring✅ID of the envelope

Return Type

Annotation

Example Usage Code Snippet

using Alohi.Signplus;
using Alohi.Signplus.Config;
using Alohi.Signplus.Models;
using Environment = Alohi.Signplus.Http.Environment;

var config = new SignplusConfig{
    Environment = Environment.Default
};

var client = new SignplusClient(config);

var signature = new AnnotationSignature("id");
var initials = new AnnotationInitials("id");
var font = new AnnotationFont(AnnotationFontFamily.Unknown, false, false);
var text = new AnnotationText(5.51, 3.68, "value", "tooltip", "dynamic_field_name", font);
var font = new AnnotationFont(AnnotationFontFamily.Unknown, false, false);
var datetime = new AnnotationDateTime(3.25, font, "color", true, "timezone", 0, AnnotationDateTimeFormat.DmyNumericSlash);
var checkbox = new AnnotationCheckbox(false, AnnotationCheckboxStyle.CircleCheck);
var input = new AddAnnotationRequest("document_id", 8, 1.18, 4.42, 7.23, 7.31, AnnotationType.Text, "recipient_id", true, signature, initials, text, datetime, checkbox);

var response = await client.Signplus.AddEnvelopeAnnotationAsync(input, "envelope_id");

Console.WriteLine(response);

​
DeleteEnvelopeAnnotationAsync

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

using Alohi.Signplus;
using Alohi.Signplus.Config;
using Environment = Alohi.Signplus.Http.Environment;

var config = new SignplusConfig{
    Environment = Environment.Default
};

var client = new SignplusClient(config);

await client.Signplus.DeleteEnvelopeAnnotationAsync("envelope_id", "annotation_id");

​
CreateTemplateAsync

Create new template

  • HTTP Method: POST
  • Endpoint: /template

Parameters

NameTypeRequiredDescription
inputCreateTemplateRequest✅The request body.

Return Type

Template

Example Usage Code Snippet

using Alohi.Signplus;
using Alohi.Signplus.Config;
using Alohi.Signplus.Models;
using Environment = Alohi.Signplus.Http.Environment;

var config = new SignplusConfig{
    Environment = Environment.Default
};

var client = new SignplusClient(config);

var input = new CreateTemplateRequest("name");

var response = await client.Signplus.CreateTemplateAsync(input);

Console.WriteLine(response);

​
ListTemplatesAsync

List templates

  • HTTP Method: POST
  • Endpoint: /templates

Parameters

NameTypeRequiredDescription
inputListTemplatesRequest❌The request body.

Return Type

ListTemplatesResponse

Example Usage Code Snippet

using Alohi.Signplus;
using Alohi.Signplus.Config;
using Alohi.Signplus.Models;
using Environment = Alohi.Signplus.Http.Environment;

var config = new SignplusConfig{
    Environment = Environment.Default
};

var client = new SignplusClient(config);

var tags = new List<string>() { "tags" };
var ids = new List<string>() { "ids" };
var input = new ListTemplatesRequest("name", tags, ids, 9, 4, "after", "before", TemplateOrderField.TemplateId, true);

var response = await client.Signplus.ListTemplatesAsync(input);

Console.WriteLine(response);

​
GetTemplateAsync

Get template

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

Parameters

NameTypeRequiredDescription
templateIdstring✅

Return Type

Template

Example Usage Code Snippet

using Alohi.Signplus;
using Alohi.Signplus.Config;
using Environment = Alohi.Signplus.Http.Environment;

var config = new SignplusConfig{
    Environment = Environment.Default
};

var client = new SignplusClient(config);

var response = await client.Signplus.GetTemplateAsync("template_id");

Console.WriteLine(response);

​
DeleteTemplateAsync

Delete template

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

Parameters

NameTypeRequiredDescription
templateIdstring✅

Example Usage Code Snippet

using Alohi.Signplus;
using Alohi.Signplus.Config;
using Environment = Alohi.Signplus.Http.Environment;

var config = new SignplusConfig{
    Environment = Environment.Default
};

var client = new SignplusClient(config);

await client.Signplus.DeleteTemplateAsync("template_id");

​
DuplicateTemplateAsync

Duplicate template

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

Parameters

NameTypeRequiredDescription
templateIdstring✅

Return Type

Template

Example Usage Code Snippet

using Alohi.Signplus;
using Alohi.Signplus.Config;
using Environment = Alohi.Signplus.Http.Environment;

var config = new SignplusConfig{
    Environment = Environment.Default
};

var client = new SignplusClient(config);

var response = await client.Signplus.DuplicateTemplateAsync("template_id");

Console.WriteLine(response);

​
AddTemplateDocumentAsync

Add template document

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

Parameters

NameTypeRequiredDescription
inputAddTemplateDocumentRequest✅The request body.
templateIdstring✅

Return Type

Document

Example Usage Code Snippet

using Alohi.Signplus;
using Alohi.Signplus.Config;
using Alohi.Signplus.Models;
using Environment = Alohi.Signplus.Http.Environment;

var config = new SignplusConfig{
    Environment = Environment.Default
};

var client = new SignplusClient(config);

var input = new AddTemplateDocumentRequest(new byte[] {});

var response = await client.Signplus.AddTemplateDocumentAsync(input, "template_id");

Console.WriteLine(response);

​
GetTemplateDocumentAsync

Get template document

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

Parameters

NameTypeRequiredDescription
templateIdstring✅
documentIdstring✅

Return Type

Document

Example Usage Code Snippet

using Alohi.Signplus;
using Alohi.Signplus.Config;
using Environment = Alohi.Signplus.Http.Environment;

var config = new SignplusConfig{
    Environment = Environment.Default
};

var client = new SignplusClient(config);

var response = await client.Signplus.GetTemplateDocumentAsync("template_id", "document_id");

Console.WriteLine(response);

​
GetTemplateDocumentsAsync

Get template documents

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

Parameters

NameTypeRequiredDescription
templateIdstring✅

Return Type

ListTemplateDocumentsResponse

Example Usage Code Snippet

using Alohi.Signplus;
using Alohi.Signplus.Config;
using Environment = Alohi.Signplus.Http.Environment;

var config = new SignplusConfig{
    Environment = Environment.Default
};

var client = new SignplusClient(config);

var response = await client.Signplus.GetTemplateDocumentsAsync("template_id");

Console.WriteLine(response);

​
AddTemplateSigningStepsAsync

Add template signing steps

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

Parameters

NameTypeRequiredDescription
inputAddTemplateSigningStepsRequest✅The request body.
templateIdstring✅

Return Type

Template

Example Usage Code Snippet

using Alohi.Signplus;
using Alohi.Signplus.Config;
using Alohi.Signplus.Models;
using Environment = Alohi.Signplus.Http.Environment;

var config = new SignplusConfig{
    Environment = Environment.Default
};

var client = new SignplusClient(config);

var recipientsItem = new TemplateRecipient("id", "uid", "name", "email", TemplateRecipientRole.Signer);
var recipients = new List<TemplateRecipient>() { recipientsItem };
var signingStepsItem = new TemplateSigningStep(recipients);
var signingSteps = new List<TemplateSigningStep>() { signingStepsItem };
var input = new AddTemplateSigningStepsRequest(signingSteps);

var response = await client.Signplus.AddTemplateSigningStepsAsync(input, "template_id");

Console.WriteLine(response);

​
RenameTemplateAsync

Rename template

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

Parameters

NameTypeRequiredDescription
inputRenameTemplateRequest✅The request body.
templateIdstring✅

Return Type

Template

Example Usage Code Snippet

using Alohi.Signplus;
using Alohi.Signplus.Config;
using Alohi.Signplus.Models;
using Environment = Alohi.Signplus.Http.Environment;

var config = new SignplusConfig{
    Environment = Environment.Default
};

var client = new SignplusClient(config);

var input = new RenameTemplateRequest("name");

var response = await client.Signplus.RenameTemplateAsync(input, "template_id");

Console.WriteLine(response);

​
SetTemplateCommentAsync

Set template comment

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

Parameters

NameTypeRequiredDescription
inputSetTemplateCommentRequest✅The request body.
templateIdstring✅

Return Type

Template

Example Usage Code Snippet

using Alohi.Signplus;
using Alohi.Signplus.Config;
using Alohi.Signplus.Models;
using Environment = Alohi.Signplus.Http.Environment;

var config = new SignplusConfig{
    Environment = Environment.Default
};

var client = new SignplusClient(config);

var input = new SetTemplateCommentRequest("comment");

var response = await client.Signplus.SetTemplateCommentAsync(input, "template_id");

Console.WriteLine(response);

​
SetTemplateNotificationAsync

Set template notification

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

Parameters

NameTypeRequiredDescription
inputEnvelopeNotification✅The request body.
templateIdstring✅

Return Type

Template

Example Usage Code Snippet

using Alohi.Signplus;
using Alohi.Signplus.Config;
using Alohi.Signplus.Models;
using Environment = Alohi.Signplus.Http.Environment;

var config = new SignplusConfig{
    Environment = Environment.Default
};

var client = new SignplusClient(config);

var input = new EnvelopeNotification("subject", "message", 10);

var response = await client.Signplus.SetTemplateNotificationAsync(input, "template_id");

Console.WriteLine(response);

​
GetTemplateAnnotationsAsync

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

using Alohi.Signplus;
using Alohi.Signplus.Config;
using Environment = Alohi.Signplus.Http.Environment;

var config = new SignplusConfig{
    Environment = Environment.Default
};

var client = new SignplusClient(config);

var response = await client.Signplus.GetTemplateAnnotationsAsync("template_id");

Console.WriteLine(response);

​
GetDocumentTemplateAnnotationsAsync

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

using Alohi.Signplus;
using Alohi.Signplus.Config;
using Environment = Alohi.Signplus.Http.Environment;

var config = new SignplusConfig{
    Environment = Environment.Default
};

var client = new SignplusClient(config);

var response = await client.Signplus.GetDocumentTemplateAnnotationsAsync("template_id", "document_id");

Console.WriteLine(response);

​
AddTemplateAnnotationAsync

Add template annotation

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

Parameters

NameTypeRequiredDescription
inputAddAnnotationRequest✅The request body.
templateIdstring✅ID of the template

Return Type

Annotation

Example Usage Code Snippet

using Alohi.Signplus;
using Alohi.Signplus.Config;
using Alohi.Signplus.Models;
using Environment = Alohi.Signplus.Http.Environment;

var config = new SignplusConfig{
    Environment = Environment.Default
};

var client = new SignplusClient(config);

var signature = new AnnotationSignature("id");
var initials = new AnnotationInitials("id");
var font = new AnnotationFont(AnnotationFontFamily.Unknown, false, false);
var text = new AnnotationText(5.51, 3.68, "value", "tooltip", "dynamic_field_name", font);
var font = new AnnotationFont(AnnotationFontFamily.Unknown, false, false);
var datetime = new AnnotationDateTime(3.25, font, "color", true, "timezone", 0, AnnotationDateTimeFormat.DmyNumericSlash);
var checkbox = new AnnotationCheckbox(false, AnnotationCheckboxStyle.CircleCheck);
var input = new AddAnnotationRequest("document_id", 8, 1.18, 4.42, 7.23, 7.31, AnnotationType.Text, "recipient_id", true, signature, initials, text, datetime, checkbox);

var response = await client.Signplus.AddTemplateAnnotationAsync(input, "template_id");

Console.WriteLine(response);

​
DeleteTemplateAnnotationAsync

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

using Alohi.Signplus;
using Alohi.Signplus.Config;
using Environment = Alohi.Signplus.Http.Environment;

var config = new SignplusConfig{
    Environment = Environment.Default
};

var client = new SignplusClient(config);

await client.Signplus.DeleteTemplateAnnotationAsync("template_id", "annotation_id");

​
CreateWebhookAsync

Create webhook

  • HTTP Method: POST
  • Endpoint: /webhook

Parameters

NameTypeRequiredDescription
inputCreateWebhookRequest✅The request body.

Return Type

Webhook

Example Usage Code Snippet

using Alohi.Signplus;
using Alohi.Signplus.Config;
using Alohi.Signplus.Models;
using Environment = Alohi.Signplus.Http.Environment;

var config = new SignplusConfig{
    Environment = Environment.Default
};

var client = new SignplusClient(config);

var input = new CreateWebhookRequest(WebhookEvent.EnvelopeExpired, "target");

var response = await client.Signplus.CreateWebhookAsync(input);

Console.WriteLine(response);

​
ListWebhooksAsync

List webhooks

  • HTTP Method: POST
  • Endpoint: /webhooks

Parameters

NameTypeRequiredDescription
inputListWebhooksRequest❌The request body.

Return Type

ListWebhooksResponse

Example Usage Code Snippet

using Alohi.Signplus;
using Alohi.Signplus.Config;
using Alohi.Signplus.Models;
using Environment = Alohi.Signplus.Http.Environment;

var config = new SignplusConfig{
    Environment = Environment.Default
};

var client = new SignplusClient(config);

var input = new ListWebhooksRequest("webhook_id", WebhookEvent.EnvelopeExpired);

var response = await client.Signplus.ListWebhooksAsync(input);

Console.WriteLine(response);

​
DeleteWebhookAsync

Delete webhook

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

Parameters

NameTypeRequiredDescription
webhookIdstring✅

Example Usage Code Snippet

using Alohi.Signplus;
using Alohi.Signplus.Config;
using Environment = Alohi.Signplus.Http.Environment;

var config = new SignplusConfig{
    Environment = Environment.Default
};

var client = new SignplusClient(config);

await client.Signplus.DeleteWebhookAsync("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<Page>❌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
Sandboxbool❌Whether the envelope is created in sandbox mode

​
ListEnvelopesRequest

Properties

NameTypeRequiredDescription
Namestring❌Name of the envelope
TagsList<string>❌List of tags
Commentstring❌Comment of the envelope
IdsList<string>❌List of envelope IDs
StatusesList<EnvelopeStatus>❌List of envelope statuses
FolderIdsList<string>❌List of folder IDs
OnlyRootFolderbool❌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
Ascendingbool❌Whether to order envelopes in ascending order
IncludeTrashbool❌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<string>❌List of tag templates
IdsList<string>❌List of templates IDs
Firstlong❌
Lastlong❌
Afterstring❌
Beforestring❌
OrderFieldTemplateOrderField❌Field to order templates by
Ascendingbool❌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<TemplateSigningStep>❌
DocumentsList<Document>❌
NotificationEnvelopeNotification❌
DynamicFieldsList<string>❌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<SigningStep>❌List of signing steps

​
AnnotationFontFamily

Font family of the text

Properties

NameTypeRequiredDescription
Unknownstring✅“UNKNOWN”
Serifstring✅“SERIF”
Sansstring✅“SANS”
Monostring✅“MONO”

​
AddTemplateSigningStepsRequest

Properties

NameTypeRequiredDescription
SigningStepsList<TemplateSigningStep>✅List of signing steps

​
SetEnvelopeCommentRequest

Properties

NameTypeRequiredDescription
Commentstring✅Comment for the envelope

​
TemplateOrderField

Field to order templates by

Properties

NameTypeRequiredDescription
TemplateIdstring✅“TEMPLATE_ID”
TemplateCreationDatestring✅“TEMPLATE_CREATION_DATE”
TemplateModificationDatestring✅“TEMPLATE_MODIFICATION_DATE”
TemplateNamestring✅“TEMPLATE_NAME”

​
EnvelopeOrderField

Field to order envelopes by

Properties

NameTypeRequiredDescription
CreationDatestring✅“CREATION_DATE”
ModificationDatestring✅“MODIFICATION_DATE”
Namestring✅“NAME”
Statusstring✅“STATUS”
LastDocumentChangestring✅“LAST_DOCUMENT_CHANGE”

​
AddEnvelopeDocumentRequest

Properties

NameTypeRequiredDescription
Filebyte[]❌File to upload in binary format

​
ListWebhooksRequest

Properties

NameTypeRequiredDescription
WebhookIdstring❌ID of the webhook
Event_WebhookEvent❌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
Checked_bool❌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
IsDuplicablebool❌Whether the envelope can be duplicated
SigningStepsList<SigningStep>❌
DocumentsList<Document>❌
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)
Type_AnnotationType✅Type of the annotation
RecipientIdstring❌ID of the recipient
Requiredbool❌
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<Annotation>❌

​
EnvelopeStatus

Status of the envelope

Properties

NameTypeRequiredDescription
Draftstring✅“DRAFT”
InProgressstring✅“IN_PROGRESS”
Completedstring✅“COMPLETED”
Expiredstring✅“EXPIRED”
Declinedstring✅“DECLINED”
Voidedstring✅“VOIDED”
Pendingstring✅“PENDING”

​
RecipientVerification

Properties

NameTypeRequiredDescription
Type_RecipientVerificationType❌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
CircleCheckstring✅“CIRCLE_CHECK”
CircleFullstring✅“CIRCLE_FULL”
SquareCheckstring✅“SQUARE_CHECK”
SquareFullstring✅“SQUARE_FULL”
CheckMarkstring✅“CHECK_MARK”
TimesSquarestring✅“TIMES_SQUARE”

​
SigningStep

Properties

NameTypeRequiredDescription
RecipientsList<Recipient>❌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
AutoFillbool❌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<Document>❌

​
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
Italicbool❌Whether the text is italic
Boldbool❌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
Event_WebhookEvent❌Event of the webhook
Targetstring❌Target URL of the webhook

​
RenameTemplateRequest

Properties

NameTypeRequiredDescription
Namestring✅Name of the template

​
ListTemplatesResponse

Properties

NameTypeRequiredDescription
HasNextPagebool❌Whether there is a next page
HasPreviousPagebool❌Whether there is a previous page
TemplatesList<Template>❌

​
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”
ReceivesCopystring✅“RECEIVES_COPY”
InPersonSignerstring✅“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)
Requiredbool❌Whether the annotation is required
Type_AnnotationType❌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
DmyNumericSlashstring✅“DMY_NUMERIC_SLASH”
MdyNumericSlashstring✅“MDY_NUMERIC_SLASH”
YmdNumericSlashstring✅“YMD_NUMERIC_SLASH”
DmyNumericDashShortstring✅“DMY_NUMERIC_DASH_SHORT”
DmyNumericDashstring✅“DMY_NUMERIC_DASH”
YmdNumericDashstring✅“YMD_NUMERIC_DASH”
MdyTextDashShortstring✅“MDY_TEXT_DASH_SHORT”
MdyTextSpaceShortstring✅“MDY_TEXT_SPACE_SHORT”
MdyTextSpacestring✅“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
RequestSignaturestring✅“REQUEST_SIGNATURE”
SignMyselfstring✅“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”
QesEidasstring✅“QES_EIDAS”
QesZertesstring✅“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”
ReceivesCopystring✅“RECEIVES_COPY”
InPersonSignerstring✅“IN_PERSON_SIGNER”

​
SetEnvelopeDynamicFieldsRequest

Properties

NameTypeRequiredDescription
DynamicFieldsList<DynamicField>✅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<TemplateRecipient>❌List of recipients

​
ListEnvelopesResponse

Properties

NameTypeRequiredDescription
HasNextPagebool❌Whether there is a next page
HasPreviousPagebool❌Whether there is a previous page
EnvelopesList<Envelope>❌

​
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
EnvelopeExpiredstring✅“ENVELOPE_EXPIRED”
EnvelopeDeclinedstring✅“ENVELOPE_DECLINED”
EnvelopeVoidedstring✅“ENVELOPE_VOIDED”
EnvelopeCompletedstring✅“ENVELOPE_COMPLETED”
EnvelopeAuditTrailstring✅“ENVELOPE_AUDIT_TRAIL”

​
CreateWebhookRequest

Properties

NameTypeRequiredDescription
Event_WebhookEvent✅Event of the webhook
Targetstring✅URL of the webhook target

​
CreateEnvelopeFromTemplateRequest

Properties

NameTypeRequiredDescription
Namestring✅Name of the envelope
Commentstring❌Comment for the envelope
Sandboxbool❌Whether the envelope is created in sandbox mode

​
ListTemplateAnnotationsResponse

Properties

NameTypeRequiredDescription
AnnotationsList<Annotation>❌

​
RenameEnvelopeRequest

Properties

NameTypeRequiredDescription
Namestring❌Name of the envelope

​
ListTemplateDocumentAnnotationsResponse

Properties

NameTypeRequiredDescription
AnnotationsList<Annotation>❌

​
ListEnvelopeDocumentsResponse

Properties

NameTypeRequiredDescription
DocumentsList<Document>❌

​
ListWebhooksResponse

Properties

NameTypeRequiredDescription
WebhooksList<Webhook>❌

​
AnnotationSignature

Signature annotation (null if annotation is not a signature)

Properties

NameTypeRequiredDescription
Idstring❌Unique identifier of the annotation signature
InstallInstall