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

Methods	Description
create_envelope	Create new envelope
create_envelope_from_template	Create new envelope from template
list_envelopes	List envelopes
get_envelope	Get envelope
delete_envelope	Delete envelope
get_envelope_document	Get envelope document
get_envelope_documents	Get envelope documents
add_envelope_document	Add envelope document
set_envelope_dynamic_fields	Set envelope dynamic fields
add_envelope_signing_steps	Add envelope signing steps
send_envelope	Send envelope for signature
duplicate_envelope	Duplicate envelope
void_envelope	Void envelope
rename_envelope	Rename envelope
set_envelope_comment	Set envelope comment
set_envelope_notification	Set envelope notification
set_envelope_expiration_date	Set envelope expiration date
set_envelope_legality_level	Set envelope legality level
get_envelope_annotations	Get envelope annotations
get_envelope_document_annotations	Get envelope document annotations
add_envelope_annotation	Add envelope annotation
delete_envelope_annotation	Delete envelope annotation
create_template	Create new template
list_templates	List templates
get_template	Get template
delete_template	Delete template
duplicate_template	Duplicate template
add_template_document	Add template document
get_template_document	Get template document
get_template_documents	Get template documents
add_template_signing_steps	Add template signing steps
rename_template	Rename template
set_template_comment	Set template comment
set_template_notification	Set template notification
get_template_annotations	Get template annotations
get_document_template_annotations	Get document template annotations
add_template_annotation	Add template annotation
delete_template_annotation	Delete template annotation
create_webhook	Create webhook
list_webhooks	List webhooks
delete_webhook	Delete webhook

create_envelope

Create new envelope

HTTP Method: POST
Endpoint: /envelope

Parameters

Name	Type	Required	Description
body	CreateEnvelopeRequest		The request body.

Return Type

Envelope

Example Usage Code Snippet

import { CreateEnvelopeRequest, Signplus } from '@alohi/signplus-typescript';

(async () => {
  const signplus = new Signplus({
    token: 'YOUR_TOKEN',
  });

  const envelopeFlowType = EnvelopeFlowType.REQUESTSIGNATURE;

  const envelopeLegalityLevel = EnvelopeLegalityLevel.SES;

  const input: CreateEnvelopeRequest = {
    name: 'name',
    flowType: envelopeFlowType,
    legalityLevel: envelopeLegalityLevel,
    expiresAt: 8,
    comment: 'comment',
    sandbox: true,
  };

  const { data } = await signplus.signplus.createEnvelope(input);

  console.log(data);
})();

create_envelope_from_template

Create new envelope from template

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

Parameters

Name	Type	Required	Description
body	CreateEnvelopeFromTemplateRequest		The request body.
templateId	string

Return Type

Envelope

Example Usage Code Snippet

import { CreateEnvelopeFromTemplateRequest, Signplus } from '@alohi/signplus-typescript';

(async () => {
  const signplus = new Signplus({
    token: 'YOUR_TOKEN',
  });

  const input: CreateEnvelopeFromTemplateRequest = {
    name: 'name',
    comment: 'comment',
    sandbox: true,
  };

  const { data } = await signplus.signplus.createEnvelopeFromTemplate('template_id', input);

  console.log(data);
})();

list_envelopes

List envelopes

HTTP Method: POST
Endpoint: /envelopes

Parameters

Name	Type	Required	Description
body	ListEnvelopesRequest		The request body.

Return Type

ListEnvelopesResponse

Example Usage Code Snippet

import { ListEnvelopesRequest, Signplus } from '@alohi/signplus-typescript';

(async () => {
  const signplus = new Signplus({
    token: 'YOUR_TOKEN',
  });

  const envelopeStatus = EnvelopeStatus.DRAFT;

  const envelopeOrderField = EnvelopeOrderField.CREATIONDATE;

  const input: ListEnvelopesRequest = {
    name: 'name',
    tags: ['tags'],
    comment: 'comment',
    ids: ['ids'],
    statuses: [envelopeStatus],
    folderIds: ['folder_ids'],
    onlyRootFolder: true,
    dateFrom: 4,
    dateTo: 7,
    uid: 'uid',
    first: 8,
    last: 9,
    after: 'after',
    before: 'before',
    orderField: envelopeOrderField,
    ascending: true,
    includeTrash: true,
  };

  const { data } = await signplus.signplus.listEnvelopes(input);

  console.log(data);
})();

get_envelope

Get envelope

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

Parameters

Name	Type	Required	Description
envelopeId	string

Return Type

Envelope

Example Usage Code Snippet

import { Signplus } from '@alohi/signplus-typescript';

(async () => {
  const signplus = new Signplus({
    token: 'YOUR_TOKEN',
  });

  const { data } = await signplus.signplus.getEnvelope('envelope_id');

  console.log(data);
})();

delete_envelope

Delete envelope

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

Parameters

Name	Type	Required	Description
envelopeId	string

Example Usage Code Snippet

import { Signplus } from '@alohi/signplus-typescript';

(async () => {
  const signplus = new Signplus({
    token: 'YOUR_TOKEN',
  });

  const { data } = await signplus.signplus.deleteEnvelope('envelope_id');

  console.log(data);
})();

get_envelope_document

Get envelope document

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

Parameters

Name	Type	Required	Description
envelopeId	string
documentId	string

Return Type

Document

Example Usage Code Snippet

import { Signplus } from '@alohi/signplus-typescript';

(async () => {
  const signplus = new Signplus({
    token: 'YOUR_TOKEN',
  });

  const { data } = await signplus.signplus.getEnvelopeDocument('envelope_id', 'document_id');

  console.log(data);
})();

get_envelope_documents

Get envelope documents

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

Parameters

Name	Type	Required	Description
envelopeId	string

Return Type

ListEnvelopeDocumentsResponse

Example Usage Code Snippet

import { Signplus } from '@alohi/signplus-typescript';

(async () => {
  const signplus = new Signplus({
    token: 'YOUR_TOKEN',
  });

  const { data } = await signplus.signplus.getEnvelopeDocuments('envelope_id');

  console.log(data);
})();

add_envelope_document

Add envelope document

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

Parameters

Name	Type	Required	Description
body	AddEnvelopeDocumentRequest		The request body.
envelopeId	string

Return Type

Document

Example Usage Code Snippet

import { AddEnvelopeDocumentRequest, Signplus } from '@alohi/signplus-typescript';

(async () => {
  const signplus = new Signplus({
    token: 'YOUR_TOKEN',
  });

  const input: AddEnvelopeDocumentRequest = {
    file: file,
  };

  const { data } = await signplus.signplus.addEnvelopeDocument('envelope_id', input);

  console.log(data);
})();

set_envelope_dynamic_fields

Set envelope dynamic fields

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

Parameters

Name	Type	Required	Description
body	SetEnvelopeDynamicFieldsRequest		The request body.
envelopeId	string

Return Type

Envelope

Example Usage Code Snippet

import { DynamicField, SetEnvelopeDynamicFieldsRequest, Signplus } from '@alohi/signplus-typescript';

(async () => {
  const signplus = new Signplus({
    token: 'YOUR_TOKEN',
  });

  const dynamicField: DynamicField = {
    name: 'name',
    value: 'value',
  };

  const input: SetEnvelopeDynamicFieldsRequest = {
    dynamicFields: [dynamicField],
  };

  const { data } = await signplus.signplus.setEnvelopeDynamicFields('envelope_id', input);

  console.log(data);
})();

add_envelope_signing_steps

Add envelope signing steps

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

Parameters

Name	Type	Required	Description
body	AddEnvelopeSigningStepsRequest		The request body.
envelopeId	string

Return Type

Envelope

Example Usage Code Snippet

import { AddEnvelopeSigningStepsRequest, SigningStep, Signplus } from '@alohi/signplus-typescript';

(async () => {
  const signplus = new Signplus({
    token: 'YOUR_TOKEN',
  });

  const recipientRole = RecipientRole.SIGNER;

  const recipientVerificationType = RecipientVerificationType.SMS;

  const recipientVerification: RecipientVerification = {
    type: recipientVerificationType,
    value: 'value',
  };

  const recipient: Recipient = {
    id: 'id',
    uid: 'uid',
    name: 'name',
    email: 'email',
    role: recipientRole,
    verification: recipientVerification,
  };

  const signingStep: SigningStep = {
    recipients: [recipient],
  };

  const input: AddEnvelopeSigningStepsRequest = {
    signingSteps: [signingStep],
  };

  const { data } = await signplus.signplus.addEnvelopeSigningSteps('envelope_id', input);

  console.log(data);
})();

send_envelope

Send envelope for signature

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

Parameters

Name	Type	Required	Description
envelopeId	string

Return Type

Envelope

Example Usage Code Snippet

import { Signplus } from '@alohi/signplus-typescript';

(async () => {
  const signplus = new Signplus({
    token: 'YOUR_TOKEN',
  });

  const { data } = await signplus.signplus.sendEnvelope('envelope_id');

  console.log(data);
})();

duplicate_envelope

Duplicate envelope

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

Parameters

Name	Type	Required	Description
envelopeId	string

Return Type

Envelope

Example Usage Code Snippet

import { Signplus } from '@alohi/signplus-typescript';

(async () => {
  const signplus = new Signplus({
    token: 'YOUR_TOKEN',
  });

  const { data } = await signplus.signplus.duplicateEnvelope('envelope_id');

  console.log(data);
})();

void_envelope

Void envelope

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

Parameters

Name	Type	Required	Description
envelopeId	string

Return Type

Envelope

Example Usage Code Snippet

import { Signplus } from '@alohi/signplus-typescript';

(async () => {
  const signplus = new Signplus({
    token: 'YOUR_TOKEN',
  });

  const { data } = await signplus.signplus.voidEnvelope('envelope_id');

  console.log(data);
})();

rename_envelope

Rename envelope

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

Parameters

Name	Type	Required	Description
body	RenameEnvelopeRequest		The request body.
envelopeId	string

Return Type

Envelope

Example Usage Code Snippet

import { RenameEnvelopeRequest, Signplus } from '@alohi/signplus-typescript';

(async () => {
  const signplus = new Signplus({
    token: 'YOUR_TOKEN',
  });

  const input: RenameEnvelopeRequest = {
    name: 'name',
  };

  const { data } = await signplus.signplus.renameEnvelope('envelope_id', input);

  console.log(data);
})();

set_envelope_comment

Set envelope comment

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

Parameters

Name	Type	Required	Description
body	SetEnvelopeCommentRequest		The request body.
envelopeId	string

Return Type

Envelope

Example Usage Code Snippet

import { SetEnvelopeCommentRequest, Signplus } from '@alohi/signplus-typescript';

(async () => {
  const signplus = new Signplus({
    token: 'YOUR_TOKEN',
  });

  const input: SetEnvelopeCommentRequest = {
    comment: 'comment',
  };

  const { data } = await signplus.signplus.setEnvelopeComment('envelope_id', input);

  console.log(data);
})();

set_envelope_notification

Set envelope notification

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

Parameters

Name	Type	Required	Description
body	EnvelopeNotification		The request body.
envelopeId	string

Return Type

Envelope

Example Usage Code Snippet

import { EnvelopeNotification, Signplus } from '@alohi/signplus-typescript';

(async () => {
  const signplus = new Signplus({
    token: 'YOUR_TOKEN',
  });

  const input: EnvelopeNotification = {
    subject: 'subject',
    message: 'message',
    reminderInterval: 1,
  };

  const { data } = await signplus.signplus.setEnvelopeNotification('envelope_id', input);

  console.log(data);
})();

set_envelope_expiration_date

Set envelope expiration date

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

Parameters

Name	Type	Required	Description
body	SetEnvelopeExpirationRequest		The request body.
envelopeId	string

Return Type

Envelope

Example Usage Code Snippet

import { SetEnvelopeExpirationRequest, Signplus } from '@alohi/signplus-typescript';

(async () => {
  const signplus = new Signplus({
    token: 'YOUR_TOKEN',
  });

  const input: SetEnvelopeExpirationRequest = {
    expiresAt: 6,
  };

  const { data } = await signplus.signplus.setEnvelopeExpirationDate('envelope_id', input);

  console.log(data);
})();

set_envelope_legality_level

Set envelope legality level

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

Parameters

Name	Type	Required	Description
body	SetEnvelopeLegalityLevelRequest		The request body.
envelopeId	string

Return Type

Envelope

Example Usage Code Snippet

import { SetEnvelopeLegalityLevelRequest, Signplus } from '@alohi/signplus-typescript';

(async () => {
  const signplus = new Signplus({
    token: 'YOUR_TOKEN',
  });

  const envelopeLegalityLevel = EnvelopeLegalityLevel.SES;

  const input: SetEnvelopeLegalityLevelRequest = {
    legalityLevel: envelopeLegalityLevel,
  };

  const { data } = await signplus.signplus.setEnvelopeLegalityLevel('envelope_id', input);

  console.log(data);
})();

get_envelope_annotations

Get envelope annotations

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

Parameters

Name	Type	Required	Description
envelopeId	string		ID of the envelope

Return Type

Annotation[]

Example Usage Code Snippet

import { Signplus } from '@alohi/signplus-typescript';

(async () => {
  const signplus = new Signplus({
    token: 'YOUR_TOKEN',
  });

  const { data } = await signplus.signplus.getEnvelopeAnnotations('envelope_id');

  console.log(data);
})();

get_envelope_document_annotations

Get envelope document annotations

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

Parameters

Name	Type	Required	Description
envelopeId	string		ID of the envelope
documentId	string		ID of document

Return Type

ListEnvelopeDocumentAnnotationsResponse

Example Usage Code Snippet

import { Signplus } from '@alohi/signplus-typescript';

(async () => {
  const signplus = new Signplus({
    token: 'YOUR_TOKEN',
  });

  const { data } = await signplus.signplus.getEnvelopeDocumentAnnotations('envelope_id', 'document_id');

  console.log(data);
})();

add_envelope_annotation

Add envelope annotation

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

Parameters

Name	Type	Required	Description
body	AddAnnotationRequest		The request body.
envelopeId	string		ID of the envelope

Return Type

Annotation

Example Usage Code Snippet

import {
  AddAnnotationRequest,
  AnnotationCheckbox,
  AnnotationDateTime,
  AnnotationInitials,
  AnnotationSignature,
  AnnotationText,
  Signplus,
} from '@alohi/signplus-typescript';

(async () => {
  const signplus = new Signplus({
    token: 'YOUR_TOKEN',
  });

  const annotationType = AnnotationType.TEXT;

  const annotationSignature: AnnotationSignature = {
    id: 'id',
  };

  const annotationInitials: AnnotationInitials = {
    id: 'id',
  };

  const annotationFontFamily = AnnotationFontFamily.UNKNOWN;

  const annotationFont: AnnotationFont = {
    family: annotationFontFamily,
    italic: true,
    bold: true,
  };

  const annotationText: AnnotationText = {
    size: 0.75,
    color: 0.4,
    value: 'value',
    tooltip: 'tooltip',
    dynamicFieldName: 'dynamic_field_name',
    font: annotationFont,
  };

  const annotationDateTimeFormat = AnnotationDateTimeFormat.DMYNUMERICSLASH;

  const annotationDateTime: AnnotationDateTime = {
    size: 2.34,
    font: annotationFont,
    color: 'color',
    autoFill: true,
    timezone: 'timezone',
    timestamp: 6,
    format: annotationDateTimeFormat,
  };

  const annotationCheckboxStyle = AnnotationCheckboxStyle.CIRCLECHECK;

  const annotationCheckbox: AnnotationCheckbox = {
    checked: true,
    style: annotationCheckboxStyle,
  };

  const input: AddAnnotationRequest = {
    recipientId: 'recipient_id',
    documentId: 'document_id',
    page: 5,
    x: 2.83,
    y: 1.27,
    width: 5.18,
    height: 4.34,
    required: true,
    type: annotationType,
    signature: annotationSignature,
    initials: annotationInitials,
    text: annotationText,
    datetime: annotationDateTime,
    checkbox: annotationCheckbox,
  };

  const { data } = await signplus.signplus.addEnvelopeAnnotation('envelope_id', input);

  console.log(data);
})();

delete_envelope_annotation

Delete envelope annotation

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

Parameters

Name	Type	Required	Description
envelopeId	string		ID of the envelope
annotationId	string		ID of the annotation to delete

Example Usage Code Snippet

import { Signplus } from '@alohi/signplus-typescript';

(async () => {
  const signplus = new Signplus({
    token: 'YOUR_TOKEN',
  });

  const { data } = await signplus.signplus.deleteEnvelopeAnnotation('envelope_id', 'annotation_id');

  console.log(data);
})();

create_template

Create new template

HTTP Method: POST
Endpoint: /template

Parameters

Name	Type	Required	Description
body	CreateTemplateRequest		The request body.

Return Type

Template

Example Usage Code Snippet

import { CreateTemplateRequest, Signplus } from '@alohi/signplus-typescript';

(async () => {
  const signplus = new Signplus({
    token: 'YOUR_TOKEN',
  });

  const input: CreateTemplateRequest = {
    name: 'name',
  };

  const { data } = await signplus.signplus.createTemplate(input);

  console.log(data);
})();

list_templates

List templates

HTTP Method: POST
Endpoint: /templates

Parameters

Name	Type	Required	Description
body	ListTemplatesRequest		The request body.

Return Type

ListTemplatesResponse

Example Usage Code Snippet

import { ListTemplatesRequest, Signplus } from '@alohi/signplus-typescript';

(async () => {
  const signplus = new Signplus({
    token: 'YOUR_TOKEN',
  });

  const templateOrderField = TemplateOrderField.TEMPLATEID;

  const input: ListTemplatesRequest = {
    name: 'name',
    tags: ['tags'],
    ids: ['ids'],
    first: 2,
    last: 123,
    after: 'after',
    before: 'before',
    orderField: templateOrderField,
    ascending: true,
  };

  const { data } = await signplus.signplus.listTemplates(input);

  console.log(data);
})();

get_template

Get template

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

Parameters

Name	Type	Required	Description
templateId	string

Return Type

Template

Example Usage Code Snippet

import { Signplus } from '@alohi/signplus-typescript';

(async () => {
  const signplus = new Signplus({
    token: 'YOUR_TOKEN',
  });

  const { data } = await signplus.signplus.getTemplate('template_id');

  console.log(data);
})();

delete_template

Delete template

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

Parameters

Name	Type	Required	Description
templateId	string

Example Usage Code Snippet

import { Signplus } from '@alohi/signplus-typescript';

(async () => {
  const signplus = new Signplus({
    token: 'YOUR_TOKEN',
  });

  const { data } = await signplus.signplus.deleteTemplate('template_id');

  console.log(data);
})();

duplicate_template

Duplicate template

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

Parameters

Name	Type	Required	Description
templateId	string

Return Type

Template

Example Usage Code Snippet

import { Signplus } from '@alohi/signplus-typescript';

(async () => {
  const signplus = new Signplus({
    token: 'YOUR_TOKEN',
  });

  const { data } = await signplus.signplus.duplicateTemplate('template_id');

  console.log(data);
})();

add_template_document

Add template document

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

Parameters

Name	Type	Required	Description
body	AddTemplateDocumentRequest		The request body.
templateId	string

Return Type

Document

Example Usage Code Snippet

import { AddTemplateDocumentRequest, Signplus } from '@alohi/signplus-typescript';

(async () => {
  const signplus = new Signplus({
    token: 'YOUR_TOKEN',
  });

  const input: AddTemplateDocumentRequest = {
    file: file,
  };

  const { data } = await signplus.signplus.addTemplateDocument('template_id', input);

  console.log(data);
})();

get_template_document

Get template document

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

Parameters

Name	Type	Required	Description
templateId	string
documentId	string

Return Type

Document

Example Usage Code Snippet

import { Signplus } from '@alohi/signplus-typescript';

(async () => {
  const signplus = new Signplus({
    token: 'YOUR_TOKEN',
  });

  const { data } = await signplus.signplus.getTemplateDocument('template_id', 'document_id');

  console.log(data);
})();

get_template_documents

Get template documents

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

Parameters

Name	Type	Required	Description
templateId	string

Return Type

ListTemplateDocumentsResponse

Example Usage Code Snippet

import { Signplus } from '@alohi/signplus-typescript';

(async () => {
  const signplus = new Signplus({
    token: 'YOUR_TOKEN',
  });

  const { data } = await signplus.signplus.getTemplateDocuments('template_id');

  console.log(data);
})();

add_template_signing_steps

Add template signing steps

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

Parameters

Name	Type	Required	Description
body	AddTemplateSigningStepsRequest		The request body.
templateId	string

Return Type

Template

Example Usage Code Snippet

import { AddTemplateSigningStepsRequest, Signplus, TemplateSigningStep } from '@alohi/signplus-typescript';

(async () => {
  const signplus = new Signplus({
    token: 'YOUR_TOKEN',
  });

  const templateRecipientRole = TemplateRecipientRole.SIGNER;

  const templateRecipient: TemplateRecipient = {
    id: 'id',
    uid: 'uid',
    name: 'name',
    email: 'email',
    role: templateRecipientRole,
  };

  const templateSigningStep: TemplateSigningStep = {
    recipients: [templateRecipient],
  };

  const input: AddTemplateSigningStepsRequest = {
    signingSteps: [templateSigningStep],
  };

  const { data } = await signplus.signplus.addTemplateSigningSteps('template_id', input);

  console.log(data);
})();

rename_template

Rename template

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

Parameters

Name	Type	Required	Description
body	RenameTemplateRequest		The request body.
templateId	string

Return Type

Template

Example Usage Code Snippet

import { RenameTemplateRequest, Signplus } from '@alohi/signplus-typescript';

(async () => {
  const signplus = new Signplus({
    token: 'YOUR_TOKEN',
  });

  const input: RenameTemplateRequest = {
    name: 'name',
  };

  const { data } = await signplus.signplus.renameTemplate('template_id', input);

  console.log(data);
})();

set_template_comment

Set template comment

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

Parameters

Name	Type	Required	Description
body	SetTemplateCommentRequest		The request body.
templateId	string

Return Type

Template

Example Usage Code Snippet

import { SetTemplateCommentRequest, Signplus } from '@alohi/signplus-typescript';

(async () => {
  const signplus = new Signplus({
    token: 'YOUR_TOKEN',
  });

  const input: SetTemplateCommentRequest = {
    comment: 'comment',
  };

  const { data } = await signplus.signplus.setTemplateComment('template_id', input);

  console.log(data);
})();

set_template_notification

Set template notification

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

Parameters

Name	Type	Required	Description
body	EnvelopeNotification		The request body.
templateId	string

Return Type

Template

Example Usage Code Snippet

import { EnvelopeNotification, Signplus } from '@alohi/signplus-typescript';

(async () => {
  const signplus = new Signplus({
    token: 'YOUR_TOKEN',
  });

  const input: EnvelopeNotification = {
    subject: 'subject',
    message: 'message',
    reminderInterval: 1,
  };

  const { data } = await signplus.signplus.setTemplateNotification('template_id', input);

  console.log(data);
})();

get_template_annotations

Get template annotations

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

Parameters

Name	Type	Required	Description
templateId	string		ID of the template

Return Type

ListTemplateAnnotationsResponse

Example Usage Code Snippet

import { Signplus } from '@alohi/signplus-typescript';

(async () => {
  const signplus = new Signplus({
    token: 'YOUR_TOKEN',
  });

  const { data } = await signplus.signplus.getTemplateAnnotations('template_id');

  console.log(data);
})();

get_document_template_annotations

Get document template annotations

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

Parameters

Name	Type	Required	Description
templateId	string		ID of the template
documentId	string		ID of document

Return Type

ListTemplateDocumentAnnotationsResponse

Example Usage Code Snippet

import { Signplus } from '@alohi/signplus-typescript';

(async () => {
  const signplus = new Signplus({
    token: 'YOUR_TOKEN',
  });

  const { data } = await signplus.signplus.getDocumentTemplateAnnotations('template_id', 'document_id');

  console.log(data);
})();

add_template_annotation

Add template annotation

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

Parameters

Name	Type	Required	Description
body	AddAnnotationRequest		The request body.
templateId	string		ID of the template

Return Type

Annotation

Example Usage Code Snippet

import {
  AddAnnotationRequest,
  AnnotationCheckbox,
  AnnotationDateTime,
  AnnotationInitials,
  AnnotationSignature,
  AnnotationText,
  Signplus,
} from '@alohi/signplus-typescript';

(async () => {
  const signplus = new Signplus({
    token: 'YOUR_TOKEN',
  });

  const annotationType = AnnotationType.TEXT;

  const annotationSignature: AnnotationSignature = {
    id: 'id',
  };

  const annotationInitials: AnnotationInitials = {
    id: 'id',
  };

  const annotationFontFamily = AnnotationFontFamily.UNKNOWN;

  const annotationFont: AnnotationFont = {
    family: annotationFontFamily,
    italic: true,
    bold: true,
  };

  const annotationText: AnnotationText = {
    size: 0.75,
    color: 0.4,
    value: 'value',
    tooltip: 'tooltip',
    dynamicFieldName: 'dynamic_field_name',
    font: annotationFont,
  };

  const annotationDateTimeFormat = AnnotationDateTimeFormat.DMYNUMERICSLASH;

  const annotationDateTime: AnnotationDateTime = {
    size: 2.34,
    font: annotationFont,
    color: 'color',
    autoFill: true,
    timezone: 'timezone',
    timestamp: 6,
    format: annotationDateTimeFormat,
  };

  const annotationCheckboxStyle = AnnotationCheckboxStyle.CIRCLECHECK;

  const annotationCheckbox: AnnotationCheckbox = {
    checked: true,
    style: annotationCheckboxStyle,
  };

  const input: AddAnnotationRequest = {
    recipientId: 'recipient_id',
    documentId: 'document_id',
    page: 5,
    x: 2.83,
    y: 1.27,
    width: 5.18,
    height: 4.34,
    required: true,
    type: annotationType,
    signature: annotationSignature,
    initials: annotationInitials,
    text: annotationText,
    datetime: annotationDateTime,
    checkbox: annotationCheckbox,
  };

  const { data } = await signplus.signplus.addTemplateAnnotation('template_id', input);

  console.log(data);
})();

delete_template_annotation

Delete template annotation

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

Parameters

Name	Type	Required	Description
templateId	string		ID of the template
annotationId	string		ID of the annotation to delete

Example Usage Code Snippet

import { Signplus } from '@alohi/signplus-typescript';

(async () => {
  const signplus = new Signplus({
    token: 'YOUR_TOKEN',
  });

  const { data } = await signplus.signplus.deleteTemplateAnnotation('template_id', 'annotation_id');

  console.log(data);
})();

create_webhook

Create webhook

HTTP Method: POST
Endpoint: /webhook

Parameters

Name	Type	Required	Description
body	CreateWebhookRequest		The request body.

Return Type

Webhook

Example Usage Code Snippet

import { CreateWebhookRequest, Signplus } from '@alohi/signplus-typescript';

(async () => {
  const signplus = new Signplus({
    token: 'YOUR_TOKEN',
  });

  const webhookEvent = WebhookEvent.ENVELOPEEXPIRED;

  const input: CreateWebhookRequest = {
    event: webhookEvent,
    target: 'target',
  };

  const { data } = await signplus.signplus.createWebhook(input);

  console.log(data);
})();

list_webhooks

List webhooks

HTTP Method: POST
Endpoint: /webhooks

Parameters

Name	Type	Required	Description
body	ListWebhooksRequest		The request body.

Return Type

ListWebhooksResponse

Example Usage Code Snippet

import { ListWebhooksRequest, Signplus } from '@alohi/signplus-typescript';

(async () => {
  const signplus = new Signplus({
    token: 'YOUR_TOKEN',
  });

  const webhookEvent = WebhookEvent.ENVELOPEEXPIRED;

  const input: ListWebhooksRequest = {
    webhookId: 'webhook_id',
    event: webhookEvent,
  };

  const { data } = await signplus.signplus.listWebhooks(input);

  console.log(data);
})();

delete_webhook

Delete webhook

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

Parameters

Name	Type	Required	Description
webhookId	string

Example Usage Code Snippet

import { Signplus } from '@alohi/signplus-typescript';

(async () => {
  const signplus = new Signplus({
    token: 'YOUR_TOKEN',
  });

  const { data } = await signplus.signplus.deleteWebhook('webhook_id');

  console.log(data);
})();

Models

Document

Properties

Name	Type	Description
id	string	Unique identifier of the document
name	string	Name of the document
filename	string	Filename of the document
pageCount	number	Number of pages in the document
pages	Page[]	List of pages in the document

Models

CreateEnvelopeRequest

Properties

Name	Type	Description
name	string	Name of the envelope
flowType	EnvelopeFlowType	Flow type of the envelope (REQUEST_SIGNATURE is a request for signature, SIGN_MYSELF is a self-signing flow)
legalityLevel	EnvelopeLegalityLevel	Legal level of the envelope (SES is Simple Electronic Signature, QES_EIDAS is Qualified Electronic Signature, QES_ZERTES is Qualified Electronic Signature with Zertes)
expiresAt	number	Unix timestamp of the expiration date
comment	string	Comment for the envelope
sandbox	boolean	Whether the envelope is created in sandbox mode

Models

ListEnvelopesRequest

Properties

Name	Type	Description
name	string	Name of the envelope
tags	string[]	List of tags
comment	string	Comment of the envelope
ids	string[]	List of envelope IDs
statuses	EnvelopeStatus[]	List of envelope statuses
folderIds	string[]	List of folder IDs
onlyRootFolder	boolean	Whether to only list envelopes in the root folder
dateFrom	number	Unix timestamp of the start date
dateTo	number	Unix timestamp of the end date
uid	string	Unique identifier of the user
first	number
last	number
after	string
before	string
orderField	EnvelopeOrderField	Field to order envelopes by
ascending	boolean	Whether to order envelopes in ascending order
includeTrash	boolean	Whether to include envelopes in the trash

Models

EnvelopeNotification

Properties

Name	Type	Description
subject	string	Subject of the notification
message	string	Message of the notification
reminderInterval	number	Interval in days to send reminder

Models

ListTemplatesRequest

Properties

Name	Type	Description
name	string	Name of the template
tags	string[]	List of tag templates
ids	string[]	List of templates IDs
first	number
last	number
after	string
before	string
orderField	TemplateOrderField	Field to order templates by
ascending	boolean	Whether to order templates in ascending order

Models

SetTemplateCommentRequest

Properties

Name	Type	Required	Description
comment	string		Comment for the template

Models

Template

Properties

Name	Type	Description
id	string	Unique identifier of the template
name	string	Name of the template
comment	string	Comment for the template
pages	number	Total number of pages in the template
legalityLevel	EnvelopeLegalityLevel	Legal level of the envelope (SES is Simple Electronic Signature, QES_EIDAS is Qualified Electronic Signature, QES_ZERTES is Qualified Electronic Signature with Zertes)
createdAt	number	Unix timestamp of the creation date
updatedAt	number	Unix timestamp of the last modification date
expirationDelay	number	Expiration delay added to the current time when an envelope is created from this template
numRecipients	number	Number of recipients in the envelope
signingSteps	TemplateSigningStep[]
documents	Document[]
notification	EnvelopeNotification
dynamicFields	string[]	List of dynamic fields

Models

RecipientVerificationType

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

Properties

Name	Type	Required	Description
SMS	string		“SMS”
PASSCODE	string		“PASSCODE”

Models

AddEnvelopeSigningStepsRequest

Properties

Name	Type	Required	Description
signingSteps	SigningStep[]		List of signing steps

Models

AnnotationFontFamily

Font family of the text

Properties

Name	Type	Description
UNKNOWN	string	“UNKNOWN”
SERIF	string	“SERIF”
SANS	string	“SANS”
MONO	string	“MONO”

Models

AddTemplateSigningStepsRequest

Properties

Name	Type	Required	Description
signingSteps	TemplateSigningStep[]		List of signing steps

Models

SetEnvelopeCommentRequest

Properties

Name	Type	Required	Description
comment	string		Comment for the envelope

Models

TemplateOrderField

Field to order templates by

Properties

Name	Type	Description
TEMPLATEID	string	“TEMPLATE_ID”
TEMPLATECREATIONDATE	string	“TEMPLATE_CREATION_DATE”
TEMPLATEMODIFICATIONDATE	string	“TEMPLATE_MODIFICATION_DATE”
TEMPLATENAME	string	“TEMPLATE_NAME”

Models

EnvelopeOrderField

Field to order envelopes by

Properties

Name	Type	Description
CREATIONDATE	string	“CREATION_DATE”
MODIFICATIONDATE	string	“MODIFICATION_DATE”
NAME	string	“NAME”
STATUS	string	“STATUS”
LASTDOCUMENTCHANGE	string	“LAST_DOCUMENT_CHANGE”

Models

AddEnvelopeDocumentRequest

Properties

Name	Type	Required	Description
file	ArrayBuffer		File to upload in binary format

Models

ListWebhooksRequest

Properties

Name	Type	Required	Description
webhookId	string		ID of the webhook
event	WebhookEvent		Event of the webhook

Models

SetEnvelopeLegalityLevelRequest

Properties

Name	Type	Required	Description
legalityLevel	EnvelopeLegalityLevel		Legal level of the envelope (SES is Simple Electronic Signature, QES_EIDAS is Qualified Electronic Signature, QES_ZERTES is Qualified Electronic Signature with Zertes)

Models

SetEnvelopeExpirationRequest

Properties

Name	Type	Required	Description
expiresAt	number		Unix timestamp of the expiration date

Models

AnnotationText

Text annotation (null if annotation is not a text)

Properties

Name	Type	Description
size	number	Font size of the text in pt
color	number	Text color in 32bit representation
value	string	Text content of the annotation
tooltip	string	Tooltip of the annotation
dynamicFieldName	string	Name of the dynamic field
font	AnnotationFont

Models

AnnotationCheckbox

Checkbox annotation (null if annotation is not a checkbox)

Properties

Name	Type	Required	Description
checked	boolean		Whether the checkbox is checked
style	AnnotationCheckboxStyle		Style of the checkbox

Models

Envelope

Properties

Name	Type	Description
id	string	Unique identifier of the envelope
name	string	Name of the envelope
comment	string	Comment for the envelope
pages	number	Total number of pages in the envelope
flowType	EnvelopeFlowType	Flow type of the envelope (REQUEST_SIGNATURE is a request for signature, SIGN_MYSELF is a self-signing flow)
legalityLevel	EnvelopeLegalityLevel	Legal level of the envelope (SES is Simple Electronic Signature, QES_EIDAS is Qualified Electronic Signature, QES_ZERTES is Qualified Electronic Signature with Zertes)
status	EnvelopeStatus	Status of the envelope
createdAt	number	Unix timestamp of the creation date
updatedAt	number	Unix timestamp of the last modification date
expiresAt	number	Unix timestamp of the expiration date
numRecipients	number	Number of recipients in the envelope
isDuplicable	boolean	Whether the envelope can be duplicated
signingSteps	SigningStep[]
documents	Document[]
notification	EnvelopeNotification

Models

AddTemplateDocumentRequest

Properties

Name	Type	Required	Description
file	ArrayBuffer		File to upload in binary format

Models

TemplateRecipient

Properties

Name	Type	Description
id	string	Unique identifier of the recipient
uid	string	Unique identifier of the user associated with the recipient
name	string	Name of the recipient
email	string	Email of the recipient
role	TemplateRecipientRole	Role of the recipient (SIGNER signs the document, RECEIVES_COPY receives a copy of the document, IN_PERSON_SIGNER signs the document in person, SENDER sends the document)

Models

AddAnnotationRequest

Properties

Name	Type	Description
documentId	string	ID of the document
page	number	Page number where the annotation is placed
x	number	X coordinate of the annotation (in % of the page width from 0 to 100) from the top left corner
y	number	Y coordinate of the annotation (in % of the page height from 0 to 100) from the top left corner
width	number	Width of the annotation (in % of the page width from 0 to 100)
height	number	Height of the annotation (in % of the page height from 0 to 100)
type	AnnotationType	Type of the annotation
recipientId	string	ID of the recipient
required	boolean
signature	AnnotationSignature	Signature annotation (null if annotation is not a signature)
initials	AnnotationInitials	Initials annotation (null if annotation is not initials)
text	AnnotationText	Text annotation (null if annotation is not a text)
datetime	AnnotationDateTime	Date annotation (null if annotation is not a date)
checkbox	AnnotationCheckbox	Checkbox annotation (null if annotation is not a checkbox)

Models

ListEnvelopeDocumentAnnotationsResponse

Properties

Name	Type	Required	Description
annotations	Annotation[]

Models

EnvelopeStatus

Status of the envelope

Properties

Name	Type	Description
DRAFT	string	“DRAFT”
INPROGRESS	string	“IN_PROGRESS”
COMPLETED	string	“COMPLETED”
EXPIRED	string	“EXPIRED”
DECLINED	string	“DECLINED”
VOIDED	string	“VOIDED”
PENDING	string	“PENDING”

Models

RecipientVerification

Properties

Name	Type	Required	Description
type	RecipientVerificationType		Type of signature verification (SMS sends a code via SMS, PASSCODE requires a code to be entered)
value	string

Models

AnnotationCheckboxStyle

Style of the checkbox

Properties

Name	Type	Description
CIRCLECHECK	string	“CIRCLE_CHECK”
CIRCLEFULL	string	“CIRCLE_FULL”
SQUARECHECK	string	“SQUARE_CHECK”
SQUAREFULL	string	“SQUARE_FULL”
CHECKMARK	string	“CHECK_MARK”
TIMESSQUARE	string	“TIMES_SQUARE”

Models

SigningStep

Properties

Name	Type	Required	Description
recipients	Recipient[]		List of recipients

Models

AnnotationDateTime

Date annotation (null if annotation is not a date)

Properties

Name	Type	Description
size	number	Font size of the text in pt
font	AnnotationFont
color	string	Color of the text in hex format
autoFill	boolean	Whether the date should be automatically filled
timezone	string	Timezone of the date
timestamp	number	Unix timestamp of the date
format	AnnotationDateTimeFormat	Format of the date time (DMY_NUMERIC_SLASH is day/month/year with slashes, MDY_NUMERIC_SLASH is month/day/year with slashes, YMD_NUMERIC_SLASH is year/month/day with slashes, DMY_NUMERIC_DASH_SHORT is day/month/year with dashes, DMY_NUMERIC_DASH is day/month/year with dashes, YMD_NUMERIC_DASH is year/month/day with dashes, MDY_TEXT_DASH_SHORT is month/day/year with dashes, MDY_TEXT_SPACE_SHORT is month/day/year with spaces, MDY_TEXT_SPACE is month/day/year with spaces)

Models

CreateTemplateRequest

Properties

Name	Type	Required	Description
name	string

Models

ListTemplateDocumentsResponse

Properties

Name	Type	Required	Description
documents	Document[]

Models

AnnotationInitials

Initials annotation (null if annotation is not initials)

Properties

Name	Type	Required	Description
id	string		Unique identifier of the annotation initials

Models

AnnotationFont

Properties

Name	Type	Description
family	AnnotationFontFamily	Font family of the text
italic	boolean	Whether the text is italic
bold	boolean	Whether the text is bold

Models

AnnotationType

Type of the annotation

Properties

Name	Type	Description
TEXT	string	“TEXT”
SIGNATURE	string	“SIGNATURE”
INITIALS	string	“INITIALS”
CHECKBOX	string	“CHECKBOX”
DATE	string	“DATE”

Models

Webhook

Properties

Name	Type	Description
id	string	Unique identifier of the webhook
event	WebhookEvent	Event of the webhook
target	string	Target URL of the webhook

Models

RenameTemplateRequest

Properties

Name	Type	Required	Description
name	string		Name of the template

Models

ListTemplatesResponse

Properties

Name	Type	Description
hasNextPage	boolean	Whether there is a next page
hasPreviousPage	boolean	Whether there is a previous page
templates	Template[]

Models

RecipientRole

Role of the recipient (SIGNER signs the document, RECEIVES_COPY receives a copy of the document, IN_PERSON_SIGNER signs the document in person, SENDER sends the document)

Properties

Name	Type	Description
SIGNER	string	“SIGNER”
RECEIVESCOPY	string	“RECEIVES_COPY”
INPERSONSIGNER	string	“IN_PERSON_SIGNER”

Models

Annotation

Properties

Name	Type	Description
id	string	Unique identifier of the annotation
recipientId	string	ID of the recipient
documentId	string	ID of the document
page	number	Page number where the annotation is placed
x	number	X coordinate of the annotation (in % of the page width from 0 to 100) from the top left corner
y	number	Y coordinate of the annotation (in % of the page height from 0 to 100) from the top left corner
width	number	Width of the annotation (in % of the page width from 0 to 100)
height	number	Height of the annotation (in % of the page height from 0 to 100)
required	boolean	Whether the annotation is required
type	AnnotationType	Type of the annotation
signature	AnnotationSignature	Signature annotation (null if annotation is not a signature)
initials	AnnotationInitials	Initials annotation (null if annotation is not initials)
text	AnnotationText	Text annotation (null if annotation is not a text)
datetime	AnnotationDateTime	Date annotation (null if annotation is not a date)
checkbox	AnnotationCheckbox	Checkbox annotation (null if annotation is not a checkbox)

Models

DynamicField

Properties

Name	Type	Required	Description
name	string		Name of the dynamic field
value	string		Value of the dynamic field

Models

AnnotationDateTimeFormat

Format of the date time (DMY_NUMERIC_SLASH is day/month/year with slashes, MDY_NUMERIC_SLASH is month/day/year with slashes, YMD_NUMERIC_SLASH is year/month/day with slashes, DMY_NUMERIC_DASH_SHORT is day/month/year with dashes, DMY_NUMERIC_DASH is day/month/year with dashes, YMD_NUMERIC_DASH is year/month/day with dashes, MDY_TEXT_DASH_SHORT is month/day/year with dashes, MDY_TEXT_SPACE_SHORT is month/day/year with spaces, MDY_TEXT_SPACE is month/day/year with spaces)

Properties

Name	Type	Description
DMYNUMERICSLASH	string	“DMY_NUMERIC_SLASH”
MDYNUMERICSLASH	string	“MDY_NUMERIC_SLASH”
YMDNUMERICSLASH	string	“YMD_NUMERIC_SLASH”
DMYNUMERICDASHSHORT	string	“DMY_NUMERIC_DASH_SHORT”
DMYNUMERICDASH	string	“DMY_NUMERIC_DASH”
YMDNUMERICDASH	string	“YMD_NUMERIC_DASH”
MDYTEXTDASHSHORT	string	“MDY_TEXT_DASH_SHORT”
MDYTEXTSPACESHORT	string	“MDY_TEXT_SPACE_SHORT”
MDYTEXTSPACE	string	“MDY_TEXT_SPACE”

Models

EnvelopeFlowType

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

Properties

Name	Type	Required	Description
REQUESTSIGNATURE	string		“REQUEST_SIGNATURE”
SIGNMYSELF	string		“SIGN_MYSELF”

Models

EnvelopeLegalityLevel

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

Properties

Name	Type	Description
SES	string	“SES”
QESEIDAS	string	“QES_EIDAS”
QESZERTES	string	“QES_ZERTES”

Models

TemplateRecipientRole

Role of the recipient (SIGNER signs the document, RECEIVES_COPY receives a copy of the document, IN_PERSON_SIGNER signs the document in person, SENDER sends the document)

Properties

Name	Type	Description
SIGNER	string	“SIGNER”
RECEIVESCOPY	string	“RECEIVES_COPY”
INPERSONSIGNER	string	“IN_PERSON_SIGNER”

Models

SetEnvelopeDynamicFieldsRequest

Properties

Name	Type	Required	Description
dynamicFields	DynamicField[]		List of dynamic fields

Models

Page

Properties

Name	Type	Required	Description
width	number		Width of the page in pixels
height	number		Height of the page in pixels

Models

TemplateSigningStep

Properties

Name	Type	Required	Description
recipients	TemplateRecipient[]		List of recipients

Models

ListEnvelopesResponse

Properties

Name	Type	Description
hasNextPage	boolean	Whether there is a next page
hasPreviousPage	boolean	Whether there is a previous page
envelopes	Envelope[]

Models

Recipient

Properties

Name	Type	Description
name	string	Name of the recipient
email	string	Email of the recipient
role	RecipientRole	Role of the recipient (SIGNER signs the document, RECEIVES_COPY receives a copy of the document, IN_PERSON_SIGNER signs the document in person, SENDER sends the document)
id	string	Unique identifier of the recipient
uid	string	Unique identifier of the user associated with the recipient
verification	RecipientVerification

Models

WebhookEvent

Event of the webhook

Properties

Name	Type	Description
ENVELOPEEXPIRED	string	“ENVELOPE_EXPIRED”
ENVELOPEDECLINED	string	“ENVELOPE_DECLINED”
ENVELOPEVOIDED	string	“ENVELOPE_VOIDED”
ENVELOPECOMPLETED	string	“ENVELOPE_COMPLETED”

Models

CreateWebhookRequest

Properties

Name	Type	Required	Description
event	WebhookEvent		Event of the webhook
target	string		URL of the webhook target

Models

CreateEnvelopeFromTemplateRequest

Properties

Name	Type	Description
name	string	Name of the envelope
comment	string	Comment for the envelope
sandbox	boolean	Whether the envelope is created in sandbox mode

Models

ListTemplateAnnotationsResponse

Properties

Name	Type	Required	Description
annotations	Annotation[]

Models

RenameEnvelopeRequest

Properties

Name	Type	Required	Description
name	string		Name of the envelope

Models

ListTemplateDocumentAnnotationsResponse

Properties

Name	Type	Required	Description
annotations	Annotation[]

Models

ListEnvelopeDocumentsResponse

Properties

Name	Type	Required	Description
documents	Document[]

Models

ListWebhooksResponse

Properties

Name	Type	Required	Description
webhooks	Webhook[]

Models

AnnotationSignature

Signature annotation (null if annotation is not a signature)

Properties

Name	Type	Required	Description
id	string		Unique identifier of the annotation signature

Install Install

On this page

create_envelope
create_envelope_from_template
list_envelopes
get_envelope
delete_envelope
get_envelope_document
get_envelope_documents
add_envelope_document
set_envelope_dynamic_fields
add_envelope_signing_steps
send_envelope
duplicate_envelope
void_envelope
rename_envelope
set_envelope_comment
set_envelope_notification
set_envelope_expiration_date
set_envelope_legality_level
get_envelope_annotations
get_envelope_document_annotations
add_envelope_annotation
delete_envelope_annotation
create_template
list_templates
get_template
delete_template
duplicate_template
add_template_document
get_template_document
get_template_documents
add_template_signing_steps
rename_template
set_template_comment
set_template_notification
get_template_annotations
get_document_template_annotations
add_template_annotation
delete_template_annotation
create_webhook
list_webhooks
delete_webhook
Models
Document
Models
CreateEnvelopeRequest
Models
ListEnvelopesRequest
Models
EnvelopeNotification
Models
ListTemplatesRequest
Models
SetTemplateCommentRequest
Models
Template
Models
RecipientVerificationType
Models
AddEnvelopeSigningStepsRequest
Models
AnnotationFontFamily
Models
AddTemplateSigningStepsRequest
Models
SetEnvelopeCommentRequest
Models
TemplateOrderField
Models
EnvelopeOrderField
Models
AddEnvelopeDocumentRequest
Models
ListWebhooksRequest
Models
SetEnvelopeLegalityLevelRequest
Models
SetEnvelopeExpirationRequest
Models
AnnotationText
Models
AnnotationCheckbox
Models
Envelope
Models
AddTemplateDocumentRequest
Models
TemplateRecipient
Models
AddAnnotationRequest
Models
ListEnvelopeDocumentAnnotationsResponse
Models
EnvelopeStatus
Models
RecipientVerification
Models
AnnotationCheckboxStyle
Models
SigningStep
Models
AnnotationDateTime
Models
CreateTemplateRequest
Models
ListTemplateDocumentsResponse
Models
AnnotationInitials
Models
AnnotationFont
Models
AnnotationType
Models
Webhook
Models
RenameTemplateRequest
Models
ListTemplatesResponse
Models
RecipientRole
Models
Annotation
Models
DynamicField
Models
AnnotationDateTimeFormat
Models
EnvelopeFlowType
Models
EnvelopeLegalityLevel
Models
TemplateRecipientRole
Models
SetEnvelopeDynamicFieldsRequest
Models
Page
Models
TemplateSigningStep
Models
ListEnvelopesResponse
Models
Recipient
Models
WebhookEvent
Models
CreateWebhookRequest
Models
CreateEnvelopeFromTemplateRequest
Models
ListTemplateAnnotationsResponse
Models
RenameEnvelopeRequest
Models
ListTemplateDocumentAnnotationsResponse
Models
ListEnvelopeDocumentsResponse
Models
ListWebhooksResponse
Models
AnnotationSignature

Get Started

Concepts

Guides

Backend SDKs

API Reference

​create_envelope

​create_envelope_from_template

​list_envelopes

​get_envelope

​delete_envelope

​get_envelope_document

​get_envelope_documents

​add_envelope_document

​set_envelope_dynamic_fields

​add_envelope_signing_steps

​send_envelope

​duplicate_envelope

​void_envelope

​rename_envelope

​set_envelope_comment

​set_envelope_notification

​set_envelope_expiration_date

​set_envelope_legality_level

​get_envelope_annotations

​get_envelope_document_annotations

​add_envelope_annotation

​delete_envelope_annotation

​create_template

​list_templates

​get_template

​delete_template

​duplicate_template

​add_template_document

​get_template_document

​get_template_documents

​add_template_signing_steps

​rename_template

​set_template_comment

​set_template_notification

​get_template_annotations

​get_document_template_annotations

​add_template_annotation

​delete_template_annotation

​create_webhook

​list_webhooks

​delete_webhook

​Models

​Document

​Models

​CreateEnvelopeRequest

​Models

​ListEnvelopesRequest

​Models

​EnvelopeNotification

​Models

​ListTemplatesRequest

​Models

​SetTemplateCommentRequest

​Models

​Template

​Models

​RecipientVerificationType

​Models

​AddEnvelopeSigningStepsRequest

​Models

​AnnotationFontFamily

​Models

​AddTemplateSigningStepsRequest

​Models

​SetEnvelopeCommentRequest

​Models

​TemplateOrderField

​Models

​EnvelopeOrderField

​Models

​AddEnvelopeDocumentRequest

​Models

​ListWebhooksRequest

​Models

​SetEnvelopeLegalityLevelRequest

create_envelope

create_envelope_from_template

list_envelopes

get_envelope

delete_envelope

get_envelope_document

get_envelope_documents

add_envelope_document

set_envelope_dynamic_fields

add_envelope_signing_steps

send_envelope

duplicate_envelope

void_envelope

rename_envelope

set_envelope_comment

set_envelope_notification

set_envelope_expiration_date

set_envelope_legality_level

get_envelope_annotations

get_envelope_document_annotations

add_envelope_annotation

delete_envelope_annotation

create_template

list_templates

get_template

delete_template

duplicate_template

add_template_document

get_template_document

get_template_documents

add_template_signing_steps

rename_template

set_template_comment

set_template_notification

get_template_annotations

get_document_template_annotations

add_template_annotation

delete_template_annotation

create_webhook

list_webhooks

delete_webhook

Models

Document

Models

CreateEnvelopeRequest

Models

ListEnvelopesRequest

Models

EnvelopeNotification

Models

ListTemplatesRequest

Models

SetTemplateCommentRequest

Models

Template

Models

RecipientVerificationType

Models

AddEnvelopeSigningStepsRequest

Models

AnnotationFontFamily

Models

AddTemplateSigningStepsRequest

Models

SetEnvelopeCommentRequest

Models

TemplateOrderField

Models

EnvelopeOrderField

Models

AddEnvelopeDocumentRequest

Models

ListWebhooksRequest

Models

SetEnvelopeLegalityLevelRequest

Models

SetEnvelopeExpirationRequest

Models

AnnotationText

Models