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

Methods	Description
CreateEnvelope	Create new envelope
CreateEnvelopeFromTemplate	Create new envelope from template
ListEnvelopes	List envelopes
GetEnvelope	Get envelope
DeleteEnvelope	Delete envelope
GetEnvelopeDocument	Get envelope document
GetEnvelopeDocuments	Get envelope documents
AddEnvelopeDocument	Add envelope document
SetEnvelopeDynamicFields	Set envelope dynamic fields
AddEnvelopeSigningSteps	Add envelope signing steps
SendEnvelope	Send envelope for signature
DuplicateEnvelope	Duplicate envelope
VoidEnvelope	Void envelope
RenameEnvelope	Rename envelope
SetEnvelopeComment	Set envelope comment
SetEnvelopeNotification	Set envelope notification
SetEnvelopeExpirationDate	Set envelope expiration date
SetEnvelopeLegalityLevel	Set envelope legality level
GetEnvelopeAnnotations	Get envelope annotations
GetEnvelopeDocumentAnnotations	Get envelope document annotations
AddEnvelopeAnnotation	Add envelope annotation
DeleteEnvelopeAnnotation	Delete envelope annotation
CreateTemplate	Create new template
ListTemplates	List templates
GetTemplate	Get template
DeleteTemplate	Delete template
DuplicateTemplate	Duplicate template
AddTemplateDocument	Add template document
GetTemplateDocument	Get template document
GetTemplateDocuments	Get template documents
AddTemplateSigningSteps	Add template signing steps
RenameTemplate	Rename template
SetTemplateComment	Set template comment
SetTemplateNotification	Set template notification
GetTemplateAnnotations	Get template annotations
GetDocumentTemplateAnnotations	Get document template annotations
AddTemplateAnnotation	Add template annotation
DeleteTemplateAnnotation	Delete template annotation
CreateWebhook	Create webhook
ListWebhooks	List webhooks
DeleteWebhook	Delete webhook

CreateEnvelope

Create new envelope

HTTP Method: POST
Endpoint: /envelope

Parameters

Name	Type	Required	Description
ctx	Context	✅	Default go language context
createEnvelopeRequest	CreateEnvelopeRequest	✅

Return Type Envelope Example Usage Code Snippet

import (
  "fmt"
  "encoding/json"
  "github.com/alohihq/signplus-go/pkg/signplusconfig"
  "github.com/alohihq/signplus-go/pkg/signplus"
)

config := signplusconfig.NewConfig()
client := signplus.NewSignplus(config)

envelopeLegalityLevel := signplus.ENVELOPE_LEGALITY_LEVEL_SES

request := signplus.CreateEnvelopeRequest{}
request.SetName("Name")
request.SetLegalityLevel(envelopeLegalityLevel)
request.SetExpiresAt(int64(123))
request.SetComment("Comment")
request.SetSandbox(true)

response, err := client.Signplus.CreateEnvelope(context.Background(), request)
if err != nil {
  panic(err)
}

fmt.Println(response)

CreateEnvelopeFromTemplate

Create new envelope from template

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

Parameters

Name	Type	Required	Description
ctx	Context	✅	Default go language context
templateId	string	✅
createEnvelopeFromTemplateRequest	CreateEnvelopeFromTemplateRequest	✅

Return Type Envelope Example Usage Code Snippet

import (
  "fmt"
  "encoding/json"
  "github.com/alohihq/signplus-go/pkg/signplusconfig"
  "github.com/alohihq/signplus-go/pkg/signplus"
)

config := signplusconfig.NewConfig()
client := signplus.NewSignplus(config)


request := signplus.CreateEnvelopeFromTemplateRequest{}
request.SetName("Name")
request.SetComment("Comment")
request.SetSandbox(true)

response, err := client.Signplus.CreateEnvelopeFromTemplate(context.Background(), "templateId", request)
if err != nil {
  panic(err)
}

fmt.Println(response)

ListEnvelopes

List envelopes

HTTP Method: POST
Endpoint: /envelopes

Parameters

Name	Type	Required	Description
ctx	Context	✅	Default go language context
listEnvelopesRequest	ListEnvelopesRequest	✅

Return Type ListEnvelopesResponse Example Usage Code Snippet

import (
  "fmt"
  "encoding/json"
  "github.com/alohihq/signplus-go/pkg/signplusconfig"
  "github.com/alohihq/signplus-go/pkg/signplus"
)

config := signplusconfig.NewConfig()
client := signplus.NewSignplus(config)

envelopeStatus := signplus.ENVELOPE_STATUS_DRAFT

envelopeOrderField := signplus.ENVELOPE_ORDER_FIELD_CREATION_DATE

request := signplus.ListEnvelopesRequest{}
request.SetName("Name")
request.SetTags([]string{})
request.SetComment("Comment")
request.SetIds([]string{})
request.SetStatuses([]signplus.EnvelopeStatus{envelopeStatus})
request.SetFolderIds([]string{})
request.SetOnlyRootFolder(true)
request.SetDateFrom(int64(123))
request.SetDateTo(int64(123))
request.SetUid("Uid")
request.SetFirst(int64(123))
request.SetLast(int64(123))
request.SetAfter("After")
request.SetBefore("Before")
request.SetOrderField(envelopeOrderField)
request.SetAscending(true)
request.SetIncludeTrash(true)

response, err := client.Signplus.ListEnvelopes(context.Background(), request)
if err != nil {
  panic(err)
}

fmt.Println(response)

GetEnvelope

Get envelope

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

Parameters

Name	Type	Required	Description
ctx	Context	✅	Default go language context
envelopeId	string	✅

Return Type Envelope Example Usage Code Snippet

import (
  "fmt"
  "encoding/json"
  "github.com/alohihq/signplus-go/pkg/signplusconfig"
  "github.com/alohihq/signplus-go/pkg/signplus"
)

config := signplusconfig.NewConfig()
client := signplus.NewSignplus(config)

response, err := client.Signplus.GetEnvelope(context.Background(), "envelopeId")
if err != nil {
  panic(err)
}

fmt.Println(response)

DeleteEnvelope

Delete envelope

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

Parameters

Name	Type	Required	Description
ctx	Context	✅	Default go language context
envelopeId	string	✅

Return Type any Example Usage Code Snippet

import (
  "fmt"
  "encoding/json"
  "github.com/alohihq/signplus-go/pkg/signplusconfig"
  "github.com/alohihq/signplus-go/pkg/signplus"
)

config := signplusconfig.NewConfig()
client := signplus.NewSignplus(config)

response, err := client.Signplus.DeleteEnvelope(context.Background(), "envelopeId")
if err != nil {
  panic(err)
}

fmt.Println(response)

GetEnvelopeDocument

Get envelope document

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

Parameters

Name	Type	Required	Description
ctx	Context	✅	Default go language context
envelopeId	string	✅
documentId	string	✅

Return Type Document Example Usage Code Snippet

import (
  "fmt"
  "encoding/json"
  "github.com/alohihq/signplus-go/pkg/signplusconfig"
  "github.com/alohihq/signplus-go/pkg/signplus"
)

config := signplusconfig.NewConfig()
client := signplus.NewSignplus(config)

response, err := client.Signplus.GetEnvelopeDocument(context.Background(), "envelopeId", "documentId")
if err != nil {
  panic(err)
}

fmt.Println(response)

GetEnvelopeDocuments

Get envelope documents

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

Parameters

Name	Type	Required	Description
ctx	Context	✅	Default go language context
envelopeId	string	✅

Return Type ListEnvelopeDocumentsResponse Example Usage Code Snippet

import (
  "fmt"
  "encoding/json"
  "github.com/alohihq/signplus-go/pkg/signplusconfig"
  "github.com/alohihq/signplus-go/pkg/signplus"
)

config := signplusconfig.NewConfig()
client := signplus.NewSignplus(config)

response, err := client.Signplus.GetEnvelopeDocuments(context.Background(), "envelopeId")
if err != nil {
  panic(err)
}

fmt.Println(response)

AddEnvelopeDocument

Add envelope document

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

Parameters

Name	Type	Required	Description
ctx	Context	✅	Default go language context
envelopeId	string	✅
addEnvelopeDocumentRequest	AddEnvelopeDocumentRequest	✅

Return Type Document Example Usage Code Snippet

import (
  "fmt"
  "encoding/json"
  "github.com/alohihq/signplus-go/pkg/signplusconfig"
  "github.com/alohihq/signplus-go/pkg/signplus"
)

config := signplusconfig.NewConfig()
client := signplus.NewSignplus(config)


request := signplus.AddEnvelopeDocumentRequest{}
request.SetFile("")

response, err := client.Signplus.AddEnvelopeDocument(context.Background(), "envelopeId", request)
if err != nil {
  panic(err)
}

fmt.Println(response)

SetEnvelopeDynamicFields

Set envelope dynamic fields

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

Parameters

Name	Type	Required	Description
ctx	Context	✅	Default go language context
envelopeId	string	✅
setEnvelopeDynamicFieldsRequest	SetEnvelopeDynamicFieldsRequest	✅

Return Type Envelope Example Usage Code Snippet

import (
  "fmt"
  "encoding/json"
  "github.com/alohihq/signplus-go/pkg/signplusconfig"
  "github.com/alohihq/signplus-go/pkg/signplus"
)

config := signplusconfig.NewConfig()
client := signplus.NewSignplus(config)


dynamicField := signplus.DynamicField{}
dynamicField.SetName("Name")
dynamicField.SetValue("Value")

request := signplus.SetEnvelopeDynamicFieldsRequest{}
request.SetDynamicFields([]signplus.DynamicField{dynamicField})

response, err := client.Signplus.SetEnvelopeDynamicFields(context.Background(), "envelopeId", request)
if err != nil {
  panic(err)
}

fmt.Println(response)

AddEnvelopeSigningSteps

Add envelope signing steps

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

Parameters

Name	Type	Required	Description
ctx	Context	✅	Default go language context
envelopeId	string	✅
addEnvelopeSigningStepsRequest	AddEnvelopeSigningStepsRequest	✅

Return Type Envelope Example Usage Code Snippet

import (
  "fmt"
  "encoding/json"
  "github.com/alohihq/signplus-go/pkg/signplusconfig"
  "github.com/alohihq/signplus-go/pkg/signplus"
)

config := signplusconfig.NewConfig()
client := signplus.NewSignplus(config)

recipientRole := signplus.RECIPIENT_ROLE_SIGNER

recipientVerificationType := signplus.RECIPIENT_VERIFICATION_TYPE_SMS

recipientVerification := signplus.RecipientVerification{}
recipientVerification.SetType_(recipientVerificationType)
recipientVerification.SetValue("Value")

recipient := signplus.Recipient{}
recipient.SetId("Id")
recipient.SetUid("Uid")
recipient.SetName("Name")
recipient.SetEmail("Email")
recipient.SetRole(recipientRole)
recipient.SetVerification(recipientVerification)

signingStep := signplus.SigningStep{}
signingStep.SetRecipients([]signplus.Recipient{recipient})

request := signplus.AddEnvelopeSigningStepsRequest{}
request.SetSigningSteps([]signplus.SigningStep{signingStep})

response, err := client.Signplus.AddEnvelopeSigningSteps(context.Background(), "envelopeId", request)
if err != nil {
  panic(err)
}

fmt.Println(response)

SendEnvelope

Send envelope for signature

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

Parameters

Name	Type	Required	Description
ctx	Context	✅	Default go language context
envelopeId	string	✅

Return Type Envelope Example Usage Code Snippet

import (
  "fmt"
  "encoding/json"
  "github.com/alohihq/signplus-go/pkg/signplusconfig"
  "github.com/alohihq/signplus-go/pkg/signplus"
)

config := signplusconfig.NewConfig()
client := signplus.NewSignplus(config)

response, err := client.Signplus.SendEnvelope(context.Background(), "envelopeId")
if err != nil {
  panic(err)
}

fmt.Println(response)

DuplicateEnvelope

Duplicate envelope

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

Parameters

Name	Type	Required	Description
ctx	Context	✅	Default go language context
envelopeId	string	✅

Return Type Envelope Example Usage Code Snippet

import (
  "fmt"
  "encoding/json"
  "github.com/alohihq/signplus-go/pkg/signplusconfig"
  "github.com/alohihq/signplus-go/pkg/signplus"
)

config := signplusconfig.NewConfig()
client := signplus.NewSignplus(config)

response, err := client.Signplus.DuplicateEnvelope(context.Background(), "envelopeId")
if err != nil {
  panic(err)
}

fmt.Println(response)

VoidEnvelope

Void envelope

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

Parameters

Name	Type	Required	Description
ctx	Context	✅	Default go language context
envelopeId	string	✅

Return Type Envelope Example Usage Code Snippet

import (
  "fmt"
  "encoding/json"
  "github.com/alohihq/signplus-go/pkg/signplusconfig"
  "github.com/alohihq/signplus-go/pkg/signplus"
)

config := signplusconfig.NewConfig()
client := signplus.NewSignplus(config)

response, err := client.Signplus.VoidEnvelope(context.Background(), "envelopeId")
if err != nil {
  panic(err)
}

fmt.Println(response)

RenameEnvelope

Rename envelope

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

Parameters

Name	Type	Required	Description
ctx	Context	✅	Default go language context
envelopeId	string	✅
renameEnvelopeRequest	RenameEnvelopeRequest	✅

Return Type Envelope Example Usage Code Snippet

import (
  "fmt"
  "encoding/json"
  "github.com/alohihq/signplus-go/pkg/signplusconfig"
  "github.com/alohihq/signplus-go/pkg/signplus"
)

config := signplusconfig.NewConfig()
client := signplus.NewSignplus(config)


request := signplus.RenameEnvelopeRequest{}
request.SetName("Name")

response, err := client.Signplus.RenameEnvelope(context.Background(), "envelopeId", request)
if err != nil {
  panic(err)
}

fmt.Println(response)

SetEnvelopeComment

Set envelope comment

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

Parameters

Name	Type	Required	Description
ctx	Context	✅	Default go language context
envelopeId	string	✅
setEnvelopeCommentRequest	SetEnvelopeCommentRequest	✅

Return Type Envelope Example Usage Code Snippet

import (
  "fmt"
  "encoding/json"
  "github.com/alohihq/signplus-go/pkg/signplusconfig"
  "github.com/alohihq/signplus-go/pkg/signplus"
)

config := signplusconfig.NewConfig()
client := signplus.NewSignplus(config)


request := signplus.SetEnvelopeCommentRequest{}
request.SetComment("Comment")

response, err := client.Signplus.SetEnvelopeComment(context.Background(), "envelopeId", request)
if err != nil {
  panic(err)
}

fmt.Println(response)

SetEnvelopeNotification

Set envelope notification

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

Parameters

Name	Type	Required	Description
ctx	Context	✅	Default go language context
envelopeId	string	✅
envelopeNotification	EnvelopeNotification	✅

Return Type Envelope Example Usage Code Snippet

import (
  "fmt"
  "encoding/json"
  "github.com/alohihq/signplus-go/pkg/signplusconfig"
  "github.com/alohihq/signplus-go/pkg/signplus"
)

config := signplusconfig.NewConfig()
client := signplus.NewSignplus(config)


request := signplus.EnvelopeNotification{}
request.SetSubject("Subject")
request.SetMessage("Message")
request.SetReminderInterval(int64(123))

response, err := client.Signplus.SetEnvelopeNotification(context.Background(), "envelopeId", request)
if err != nil {
  panic(err)
}

fmt.Println(response)

SetEnvelopeExpirationDate

Set envelope expiration date

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

Parameters

Name	Type	Required	Description
ctx	Context	✅	Default go language context
envelopeId	string	✅
setEnvelopeExpirationRequest	SetEnvelopeExpirationRequest	✅

Return Type Envelope Example Usage Code Snippet

import (
  "fmt"
  "encoding/json"
  "github.com/alohihq/signplus-go/pkg/signplusconfig"
  "github.com/alohihq/signplus-go/pkg/signplus"
)

config := signplusconfig.NewConfig()
client := signplus.NewSignplus(config)


request := signplus.SetEnvelopeExpirationRequest{}
request.SetExpiresAt(int64(123))

response, err := client.Signplus.SetEnvelopeExpirationDate(context.Background(), "envelopeId", request)
if err != nil {
  panic(err)
}

fmt.Println(response)

SetEnvelopeLegalityLevel

Set envelope legality level

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

Parameters

Name	Type	Required	Description
ctx	Context	✅	Default go language context
envelopeId	string	✅
setEnvelopeLegalityLevelRequest	SetEnvelopeLegalityLevelRequest	✅

Return Type Envelope Example Usage Code Snippet

import (
  "fmt"
  "encoding/json"
  "github.com/alohihq/signplus-go/pkg/signplusconfig"
  "github.com/alohihq/signplus-go/pkg/signplus"
)

config := signplusconfig.NewConfig()
client := signplus.NewSignplus(config)

envelopeLegalityLevel := signplus.ENVELOPE_LEGALITY_LEVEL_SES

request := signplus.SetEnvelopeLegalityLevelRequest{}
request.SetLegalityLevel(envelopeLegalityLevel)

response, err := client.Signplus.SetEnvelopeLegalityLevel(context.Background(), "envelopeId", request)
if err != nil {
  panic(err)
}

fmt.Println(response)

GetEnvelopeAnnotations

Get envelope annotations

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

Parameters

Name	Type	Required	Description
ctx	Context	✅	Default go language context
envelopeId	string	✅	ID of the envelope

Return Type []Annotation Example Usage Code Snippet

import (
  "fmt"
  "encoding/json"
  "github.com/alohihq/signplus-go/pkg/signplusconfig"
  "github.com/alohihq/signplus-go/pkg/signplus"
)

config := signplusconfig.NewConfig()
client := signplus.NewSignplus(config)

response, err := client.Signplus.GetEnvelopeAnnotations(context.Background(), "envelopeId")
if err != nil {
  panic(err)
}

fmt.Println(response)

GetEnvelopeDocumentAnnotations

Get envelope document annotations

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

Parameters

Name	Type	Required	Description
ctx	Context	✅	Default go language context
envelopeId	string	✅	ID of the envelope
documentId	string	✅	ID of document

Return Type ListEnvelopeDocumentAnnotationsResponse Example Usage Code Snippet

import (
  "fmt"
  "encoding/json"
  "github.com/alohihq/signplus-go/pkg/signplusconfig"
  "github.com/alohihq/signplus-go/pkg/signplus"
)

config := signplusconfig.NewConfig()
client := signplus.NewSignplus(config)

response, err := client.Signplus.GetEnvelopeDocumentAnnotations(context.Background(), "envelopeId", "documentId")
if err != nil {
  panic(err)
}

fmt.Println(response)

AddEnvelopeAnnotation

Add envelope annotation

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

Parameters

Name	Type	Required	Description
ctx	Context	✅	Default go language context
envelopeId	string	✅	ID of the envelope
addAnnotationRequest	AddAnnotationRequest	✅

Return Type Annotation Example Usage Code Snippet

import (
  "fmt"
  "encoding/json"
  "github.com/alohihq/signplus-go/pkg/signplusconfig"
  "github.com/alohihq/signplus-go/pkg/signplus"
)

config := signplusconfig.NewConfig()
client := signplus.NewSignplus(config)

annotationType := signplus.ANNOTATION_TYPE_TEXT


annotationSignature := signplus.AnnotationSignature{}
annotationSignature.SetId("Id")


annotationInitials := signplus.AnnotationInitials{}
annotationInitials.SetId("Id")

annotationFontFamily := signplus.ANNOTATION_FONT_FAMILY_UNKNOWN

annotationFont := signplus.AnnotationFont{}
annotationFont.SetFamily(annotationFontFamily)
annotationFont.SetItalic(true)
annotationFont.SetBold(true)

annotationText := signplus.AnnotationText{}
annotationText.SetSize(float64(123))
annotationText.SetColor(float64(123))
annotationText.SetValue("Value")
annotationText.SetTooltip("Tooltip")
annotationText.SetDynamicFieldName("DynamicFieldName")
annotationText.SetFont(annotationFont)

annotationFontFamily := signplus.ANNOTATION_FONT_FAMILY_UNKNOWN

annotationFont := signplus.AnnotationFont{}
annotationFont.SetFamily(annotationFontFamily)
annotationFont.SetItalic(true)
annotationFont.SetBold(true)

annotationDateTimeFormat := signplus.ANNOTATION_DATE_TIME_FORMAT_DMY_NUMERIC_SLASH

annotationDateTime := signplus.AnnotationDateTime{}
annotationDateTime.SetSize(float64(123))
annotationDateTime.SetFont(annotationFont)
annotationDateTime.SetColor("Color")
annotationDateTime.SetAutoFill(true)
annotationDateTime.SetTimezone("Timezone")
annotationDateTime.SetTimestamp(int64(123))
annotationDateTime.SetFormat(annotationDateTimeFormat)

annotationCheckboxStyle := signplus.ANNOTATION_CHECKBOX_STYLE_CIRCLE_CHECK

annotationCheckbox := signplus.AnnotationCheckbox{}
annotationCheckbox.SetChecked(true)
annotationCheckbox.SetStyle(annotationCheckboxStyle)

request := signplus.AddAnnotationRequest{}
request.SetRecipientId("RecipientId")
request.SetDocumentId("DocumentId")
request.SetPage(int64(123))
request.SetX(float64(123))
request.SetY(float64(123))
request.SetWidth(float64(123))
request.SetHeight(float64(123))
request.SetRequired(true)
request.SetType_(annotationType)
request.SetSignature(annotationSignature)
request.SetInitials(annotationInitials)
request.SetText(annotationText)
request.SetDatetime(annotationDateTime)
request.SetCheckbox(annotationCheckbox)

response, err := client.Signplus.AddEnvelopeAnnotation(context.Background(), "envelopeId", request)
if err != nil {
  panic(err)
}

fmt.Println(response)

DeleteEnvelopeAnnotation

Delete envelope annotation

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

Parameters

Name	Type	Required	Description
ctx	Context	✅	Default go language context
envelopeId	string	✅	ID of the envelope
annotationId	string	✅	ID of the annotation to delete

Return Type any Example Usage Code Snippet

import (
  "fmt"
  "encoding/json"
  "github.com/alohihq/signplus-go/pkg/signplusconfig"
  "github.com/alohihq/signplus-go/pkg/signplus"
)

config := signplusconfig.NewConfig()
client := signplus.NewSignplus(config)

response, err := client.Signplus.DeleteEnvelopeAnnotation(context.Background(), "envelopeId", "annotationId")
if err != nil {
  panic(err)
}

fmt.Println(response)

CreateTemplate

Create new template

HTTP Method: POST
Endpoint: /template

Parameters

Name	Type	Required	Description
ctx	Context	✅	Default go language context
createTemplateRequest	CreateTemplateRequest	✅

Return Type Template Example Usage Code Snippet

import (
  "fmt"
  "encoding/json"
  "github.com/alohihq/signplus-go/pkg/signplusconfig"
  "github.com/alohihq/signplus-go/pkg/signplus"
)

config := signplusconfig.NewConfig()
client := signplus.NewSignplus(config)


request := signplus.CreateTemplateRequest{}
request.SetName("Name")

response, err := client.Signplus.CreateTemplate(context.Background(), request)
if err != nil {
  panic(err)
}

fmt.Println(response)

ListTemplates

List templates

HTTP Method: POST
Endpoint: /templates

Parameters

Name	Type	Required	Description
ctx	Context	✅	Default go language context
listTemplatesRequest	ListTemplatesRequest	✅

Return Type ListTemplatesResponse Example Usage Code Snippet

import (
  "fmt"
  "encoding/json"
  "github.com/alohihq/signplus-go/pkg/signplusconfig"
  "github.com/alohihq/signplus-go/pkg/signplus"
)

config := signplusconfig.NewConfig()
client := signplus.NewSignplus(config)

templateOrderField := signplus.TEMPLATE_ORDER_FIELD_TEMPLATE_ID

request := signplus.ListTemplatesRequest{}
request.SetName("Name")
request.SetTags([]string{})
request.SetIds([]string{})
request.SetFirst(int64(123))
request.SetLast(int64(123))
request.SetAfter("After")
request.SetBefore("Before")
request.SetOrderField(templateOrderField)
request.SetAscending(true)

response, err := client.Signplus.ListTemplates(context.Background(), request)
if err != nil {
  panic(err)
}

fmt.Println(response)

GetTemplate

Get template

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

Parameters

Name	Type	Required	Description
ctx	Context	✅	Default go language context
templateId	string	✅

Return Type Template Example Usage Code Snippet

import (
  "fmt"
  "encoding/json"
  "github.com/alohihq/signplus-go/pkg/signplusconfig"
  "github.com/alohihq/signplus-go/pkg/signplus"
)

config := signplusconfig.NewConfig()
client := signplus.NewSignplus(config)

response, err := client.Signplus.GetTemplate(context.Background(), "templateId")
if err != nil {
  panic(err)
}

fmt.Println(response)

DeleteTemplate

Delete template

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

Parameters

Name	Type	Required	Description
ctx	Context	✅	Default go language context
templateId	string	✅

Return Type any Example Usage Code Snippet

import (
  "fmt"
  "encoding/json"
  "github.com/alohihq/signplus-go/pkg/signplusconfig"
  "github.com/alohihq/signplus-go/pkg/signplus"
)

config := signplusconfig.NewConfig()
client := signplus.NewSignplus(config)

response, err := client.Signplus.DeleteTemplate(context.Background(), "templateId")
if err != nil {
  panic(err)
}

fmt.Println(response)

DuplicateTemplate

Duplicate template

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

Parameters

Name	Type	Required	Description
ctx	Context	✅	Default go language context
templateId	string	✅

Return Type Template Example Usage Code Snippet

import (
  "fmt"
  "encoding/json"
  "github.com/alohihq/signplus-go/pkg/signplusconfig"
  "github.com/alohihq/signplus-go/pkg/signplus"
)

config := signplusconfig.NewConfig()
client := signplus.NewSignplus(config)

response, err := client.Signplus.DuplicateTemplate(context.Background(), "templateId")
if err != nil {
  panic(err)
}

fmt.Println(response)

AddTemplateDocument

Add template document

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

Parameters

Name	Type	Required	Description
ctx	Context	✅	Default go language context
templateId	string	✅
addTemplateDocumentRequest	AddTemplateDocumentRequest	✅

Return Type Document Example Usage Code Snippet

import (
  "fmt"
  "encoding/json"
  "github.com/alohihq/signplus-go/pkg/signplusconfig"
  "github.com/alohihq/signplus-go/pkg/signplus"
)

config := signplusconfig.NewConfig()
client := signplus.NewSignplus(config)


request := signplus.AddTemplateDocumentRequest{}
request.SetFile("")

response, err := client.Signplus.AddTemplateDocument(context.Background(), "templateId", request)
if err != nil {
  panic(err)
}

fmt.Println(response)

GetTemplateDocument

Get template document

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

Parameters

Name	Type	Required	Description
ctx	Context	✅	Default go language context
templateId	string	✅
documentId	string	✅

Return Type Document Example Usage Code Snippet

import (
  "fmt"
  "encoding/json"
  "github.com/alohihq/signplus-go/pkg/signplusconfig"
  "github.com/alohihq/signplus-go/pkg/signplus"
)

config := signplusconfig.NewConfig()
client := signplus.NewSignplus(config)

response, err := client.Signplus.GetTemplateDocument(context.Background(), "templateId", "documentId")
if err != nil {
  panic(err)
}

fmt.Println(response)

GetTemplateDocuments

Get template documents

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

Parameters

Name	Type	Required	Description
ctx	Context	✅	Default go language context
templateId	string	✅

Return Type ListTemplateDocumentsResponse Example Usage Code Snippet

import (
  "fmt"
  "encoding/json"
  "github.com/alohihq/signplus-go/pkg/signplusconfig"
  "github.com/alohihq/signplus-go/pkg/signplus"
)

config := signplusconfig.NewConfig()
client := signplus.NewSignplus(config)

response, err := client.Signplus.GetTemplateDocuments(context.Background(), "templateId")
if err != nil {
  panic(err)
}

fmt.Println(response)

AddTemplateSigningSteps

Add template signing steps

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

Parameters

Name	Type	Required	Description
ctx	Context	✅	Default go language context
templateId	string	✅
addTemplateSigningStepsRequest	AddTemplateSigningStepsRequest	✅

Return Type Template Example Usage Code Snippet

import (
  "fmt"
  "encoding/json"
  "github.com/alohihq/signplus-go/pkg/signplusconfig"
  "github.com/alohihq/signplus-go/pkg/signplus"
)

config := signplusconfig.NewConfig()
client := signplus.NewSignplus(config)

templateRecipientRole := signplus.TEMPLATE_RECIPIENT_ROLE_SIGNER

templateRecipient := signplus.TemplateRecipient{}
templateRecipient.SetId("Id")
templateRecipient.SetUid("Uid")
templateRecipient.SetName("Name")
templateRecipient.SetEmail("Email")
templateRecipient.SetRole(templateRecipientRole)

templateSigningStep := signplus.TemplateSigningStep{}
templateSigningStep.SetRecipients([]signplus.TemplateRecipient{templateRecipient})

request := signplus.AddTemplateSigningStepsRequest{}
request.SetSigningSteps([]signplus.TemplateSigningStep{templateSigningStep})

response, err := client.Signplus.AddTemplateSigningSteps(context.Background(), "templateId", request)
if err != nil {
  panic(err)
}

fmt.Println(response)

RenameTemplate

Rename template

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

Parameters

Name	Type	Required	Description
ctx	Context	✅	Default go language context
templateId	string	✅
renameTemplateRequest	RenameTemplateRequest	✅

Return Type Template Example Usage Code Snippet

import (
  "fmt"
  "encoding/json"
  "github.com/alohihq/signplus-go/pkg/signplusconfig"
  "github.com/alohihq/signplus-go/pkg/signplus"
)

config := signplusconfig.NewConfig()
client := signplus.NewSignplus(config)


request := signplus.RenameTemplateRequest{}
request.SetName("Name")

response, err := client.Signplus.RenameTemplate(context.Background(), "templateId", request)
if err != nil {
  panic(err)
}

fmt.Println(response)

SetTemplateComment

Set template comment

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

Parameters

Name	Type	Required	Description
ctx	Context	✅	Default go language context
templateId	string	✅
setTemplateCommentRequest	SetTemplateCommentRequest	✅

Return Type Template Example Usage Code Snippet

import (
  "fmt"
  "encoding/json"
  "github.com/alohihq/signplus-go/pkg/signplusconfig"
  "github.com/alohihq/signplus-go/pkg/signplus"
)

config := signplusconfig.NewConfig()
client := signplus.NewSignplus(config)


request := signplus.SetTemplateCommentRequest{}
request.SetComment("Comment")

response, err := client.Signplus.SetTemplateComment(context.Background(), "templateId", request)
if err != nil {
  panic(err)
}

fmt.Println(response)

SetTemplateNotification

Set template notification

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

Parameters

Name	Type	Required	Description
ctx	Context	✅	Default go language context
templateId	string	✅
envelopeNotification	EnvelopeNotification	✅

Return Type Template Example Usage Code Snippet

import (
  "fmt"
  "encoding/json"
  "github.com/alohihq/signplus-go/pkg/signplusconfig"
  "github.com/alohihq/signplus-go/pkg/signplus"
)

config := signplusconfig.NewConfig()
client := signplus.NewSignplus(config)


request := signplus.EnvelopeNotification{}
request.SetSubject("Subject")
request.SetMessage("Message")
request.SetReminderInterval(int64(123))

response, err := client.Signplus.SetTemplateNotification(context.Background(), "templateId", request)
if err != nil {
  panic(err)
}

fmt.Println(response)

GetTemplateAnnotations

Get template annotations

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

Parameters

Name	Type	Required	Description
ctx	Context	✅	Default go language context
templateId	string	✅	ID of the template

Return Type ListTemplateAnnotationsResponse Example Usage Code Snippet

import (
  "fmt"
  "encoding/json"
  "github.com/alohihq/signplus-go/pkg/signplusconfig"
  "github.com/alohihq/signplus-go/pkg/signplus"
)

config := signplusconfig.NewConfig()
client := signplus.NewSignplus(config)

response, err := client.Signplus.GetTemplateAnnotations(context.Background(), "templateId")
if err != nil {
  panic(err)
}

fmt.Println(response)

GetDocumentTemplateAnnotations

Get document template annotations

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

Parameters

Name	Type	Required	Description
ctx	Context	✅	Default go language context
templateId	string	✅	ID of the template
documentId	string	✅	ID of document

Return Type ListTemplateDocumentAnnotationsResponse Example Usage Code Snippet

import (
  "fmt"
  "encoding/json"
  "github.com/alohihq/signplus-go/pkg/signplusconfig"
  "github.com/alohihq/signplus-go/pkg/signplus"
)

config := signplusconfig.NewConfig()
client := signplus.NewSignplus(config)

response, err := client.Signplus.GetDocumentTemplateAnnotations(context.Background(), "templateId", "documentId")
if err != nil {
  panic(err)
}

fmt.Println(response)

AddTemplateAnnotation

Add template annotation

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

Parameters

Name	Type	Required	Description
ctx	Context	✅	Default go language context
templateId	string	✅	ID of the template
addAnnotationRequest	AddAnnotationRequest	✅

Return Type Annotation Example Usage Code Snippet

import (
  "fmt"
  "encoding/json"
  "github.com/alohihq/signplus-go/pkg/signplusconfig"
  "github.com/alohihq/signplus-go/pkg/signplus"
)

config := signplusconfig.NewConfig()
client := signplus.NewSignplus(config)

annotationType := signplus.ANNOTATION_TYPE_TEXT


annotationSignature := signplus.AnnotationSignature{}
annotationSignature.SetId("Id")


annotationInitials := signplus.AnnotationInitials{}
annotationInitials.SetId("Id")

annotationFontFamily := signplus.ANNOTATION_FONT_FAMILY_UNKNOWN

annotationFont := signplus.AnnotationFont{}
annotationFont.SetFamily(annotationFontFamily)
annotationFont.SetItalic(true)
annotationFont.SetBold(true)

annotationText := signplus.AnnotationText{}
annotationText.SetSize(float64(123))
annotationText.SetColor(float64(123))
annotationText.SetValue("Value")
annotationText.SetTooltip("Tooltip")
annotationText.SetDynamicFieldName("DynamicFieldName")
annotationText.SetFont(annotationFont)

annotationFontFamily := signplus.ANNOTATION_FONT_FAMILY_UNKNOWN

annotationFont := signplus.AnnotationFont{}
annotationFont.SetFamily(annotationFontFamily)
annotationFont.SetItalic(true)
annotationFont.SetBold(true)

annotationDateTimeFormat := signplus.ANNOTATION_DATE_TIME_FORMAT_DMY_NUMERIC_SLASH

annotationDateTime := signplus.AnnotationDateTime{}
annotationDateTime.SetSize(float64(123))
annotationDateTime.SetFont(annotationFont)
annotationDateTime.SetColor("Color")
annotationDateTime.SetAutoFill(true)
annotationDateTime.SetTimezone("Timezone")
annotationDateTime.SetTimestamp(int64(123))
annotationDateTime.SetFormat(annotationDateTimeFormat)

annotationCheckboxStyle := signplus.ANNOTATION_CHECKBOX_STYLE_CIRCLE_CHECK

annotationCheckbox := signplus.AnnotationCheckbox{}
annotationCheckbox.SetChecked(true)
annotationCheckbox.SetStyle(annotationCheckboxStyle)

request := signplus.AddAnnotationRequest{}
request.SetRecipientId("RecipientId")
request.SetDocumentId("DocumentId")
request.SetPage(int64(123))
request.SetX(float64(123))
request.SetY(float64(123))
request.SetWidth(float64(123))
request.SetHeight(float64(123))
request.SetRequired(true)
request.SetType_(annotationType)
request.SetSignature(annotationSignature)
request.SetInitials(annotationInitials)
request.SetText(annotationText)
request.SetDatetime(annotationDateTime)
request.SetCheckbox(annotationCheckbox)

response, err := client.Signplus.AddTemplateAnnotation(context.Background(), "templateId", request)
if err != nil {
  panic(err)
}

fmt.Println(response)

DeleteTemplateAnnotation

Delete template annotation

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

Parameters

Name	Type	Required	Description
ctx	Context	✅	Default go language context
templateId	string	✅	ID of the template
annotationId	string	✅	ID of the annotation to delete

Return Type any Example Usage Code Snippet

import (
  "fmt"
  "encoding/json"
  "github.com/alohihq/signplus-go/pkg/signplusconfig"
  "github.com/alohihq/signplus-go/pkg/signplus"
)

config := signplusconfig.NewConfig()
client := signplus.NewSignplus(config)

response, err := client.Signplus.DeleteTemplateAnnotation(context.Background(), "templateId", "annotationId")
if err != nil {
  panic(err)
}

fmt.Println(response)

CreateWebhook

Create webhook

HTTP Method: POST
Endpoint: /webhook

Parameters

Name	Type	Required	Description
ctx	Context	✅	Default go language context
createWebhookRequest	CreateWebhookRequest	✅

Return Type Webhook Example Usage Code Snippet

import (
  "fmt"
  "encoding/json"
  "github.com/alohihq/signplus-go/pkg/signplusconfig"
  "github.com/alohihq/signplus-go/pkg/signplus"
)

config := signplusconfig.NewConfig()
client := signplus.NewSignplus(config)

webhookEvent := signplus.WEBHOOK_EVENT_ENVELOPE_EXPIRED

request := signplus.CreateWebhookRequest{}
request.SetEvent(webhookEvent)
request.SetTarget("Target")

response, err := client.Signplus.CreateWebhook(context.Background(), request)
if err != nil {
  panic(err)
}

fmt.Println(response)

ListWebhooks

List webhooks

HTTP Method: POST
Endpoint: /webhooks

Parameters

Name	Type	Required	Description
ctx	Context	✅	Default go language context
listWebhooksRequest	ListWebhooksRequest	✅

Return Type ListWebhooksResponse Example Usage Code Snippet

import (
  "fmt"
  "encoding/json"
  "github.com/alohihq/signplus-go/pkg/signplusconfig"
  "github.com/alohihq/signplus-go/pkg/signplus"
)

config := signplusconfig.NewConfig()
client := signplus.NewSignplus(config)

webhookEvent := signplus.WEBHOOK_EVENT_ENVELOPE_EXPIRED

request := signplus.ListWebhooksRequest{}
request.SetWebhookId("WebhookId")
request.SetEvent(webhookEvent)

response, err := client.Signplus.ListWebhooks(context.Background(), request)
if err != nil {
  panic(err)
}

fmt.Println(response)

DeleteWebhook

Delete webhook

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

Parameters

Name	Type	Required	Description
ctx	Context	✅	Default go language context
webhookId	string	✅

Return Type any Example Usage Code Snippet

import (
  "fmt"
  "encoding/json"
  "github.com/alohihq/signplus-go/pkg/signplusconfig"
  "github.com/alohihq/signplus-go/pkg/signplus"
)

config := signplusconfig.NewConfig()
client := signplus.NewSignplus(config)

response, err := client.Signplus.DeleteWebhook(context.Background(), "webhookId")
if err != nil {
  panic(err)
}

fmt.Println(response)

Models

Document

Properties

Name	Type	Required	Description
Id	string	❌	Unique identifier of the document
Name	string	❌	Name of the document
Filename	string	❌	Filename of the document
PageCount	int64	❌	Number of pages in the document
Pages	[]signplus.Page	❌	List of pages in the document

TemplateSigningStep

Properties

Name	Type	Required	Description
Recipients	[]signplus.TemplateRecipient	❌	List of recipients

ListEnvelopeDocumentAnnotationsResponse

Properties

Name	Type	Required	Description
Annotations	[]signplus.Annotation	❌

Template

Properties

Name	Type	Required	Description
Id	string	❌	Unique identifier of the template
Name	string	❌	Name of the template
Comment	string	❌	Comment for the template
Pages	int64	❌	Total number of pages in the template
LegalityLevel	signplus.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	int64	❌	Unix timestamp of the creation date
UpdatedAt	int64	❌	Unix timestamp of the last modification date
ExpirationDelay	int64	❌	Expiration delay added to the current time when an envelope is created from this template
NumRecipients	int64	❌	Number of recipients in the envelope
SigningSteps	[]signplus.TemplateSigningStep	❌
Documents	[]signplus.Document	❌
Notification	signplus.EnvelopeNotification	❌
DynamicFields	[]string	❌	List of dynamic fields

WebhookEvent

Event of the webhook Properties

Name	Type	Required	Description
ENVELOPE_EXPIRED	string	✅	“ENVELOPE_EXPIRED”
ENVELOPE_DECLINED	string	✅	“ENVELOPE_DECLINED”
ENVELOPE_VOIDED	string	✅	“ENVELOPE_VOIDED”
ENVELOPE_COMPLETED	string	✅	“ENVELOPE_COMPLETED”
ENVELOPE_AUDIT_TRAIL	string	✅	“ENVELOPE_AUDIT_TRAIL”

RenameTemplateRequest

Properties

Name	Type	Required	Description
Name	string	✅	Name of the template

AnnotationCheckboxStyle

Style of the checkbox Properties

Name	Type	Required	Description
CIRCLE_CHECK	string	✅	“CIRCLE_CHECK”
CIRCLE_FULL	string	✅	“CIRCLE_FULL”
SQUARE_CHECK	string	✅	“SQUARE_CHECK”
SQUARE_FULL	string	✅	“SQUARE_FULL”
CHECK_MARK	string	✅	“CHECK_MARK”
TIMES_SQUARE	string	✅	“TIMES_SQUARE”

AnnotationInitials

Initials annotation (null if annotation is not initials) Properties

Name	Type	Required	Description
Id	string	❌	Unique identifier of the annotation initials

RenameEnvelopeRequest

Properties

Name	Type	Required	Description
Name	string	❌	Name of the envelope

DynamicField

Properties

Name	Type	Required	Description
Name	string	❌	Name of the dynamic field
Value	string	❌	Value of the dynamic field

SetEnvelopeDynamicFieldsRequest

Properties

Name	Type	Required	Description
DynamicFields	[]signplus.DynamicField	✅	List of dynamic fields

AddEnvelopeSigningStepsRequest

Properties

Name	Type	Required	Description
SigningSteps	[]signplus.SigningStep	❌	List of signing steps

EnvelopeFlowType

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

Name	Type	Required	Description
REQUEST_SIGNATURE	string	✅	“REQUEST_SIGNATURE”
SIGN_MYSELF	string	✅	“SIGN_MYSELF”

SetEnvelopeCommentRequest

Properties

Name	Type	Required	Description
Comment	string	✅	Comment for the envelope

AnnotationText

Text annotation (null if annotation is not a text) Properties

Name	Type	Required	Description
Size	float64	❌	Font size of the text in pt
Color	float64	❌	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	signplus.AnnotationFont	❌

Envelope

Properties

Name	Type	Required	Description
Id	string	❌	Unique identifier of the envelope
Name	string	❌	Name of the envelope
Comment	string	❌	Comment for the envelope
Pages	int64	❌	Total number of pages in the envelope
FlowType	signplus.EnvelopeFlowType	❌	Flow type of the envelope (REQUEST_SIGNATURE is a request for signature, SIGN_MYSELF is a self-signing flow)
LegalityLevel	signplus.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	signplus.EnvelopeStatus	❌	Status of the envelope
CreatedAt	int64	❌	Unix timestamp of the creation date
UpdatedAt	int64	❌	Unix timestamp of the last modification date
ExpiresAt	int64	❌	Unix timestamp of the expiration date
NumRecipients	int64	❌	Number of recipients in the envelope
IsDuplicable	bool	❌	Whether the envelope can be duplicated
SigningSteps	[]signplus.SigningStep	❌
Documents	[]signplus.Document	❌
Notification	signplus.EnvelopeNotification	❌

AddTemplateSigningStepsRequest

Properties

Name	Type	Required	Description
SigningSteps	[]signplus.TemplateSigningStep	✅	List of signing steps

CreateEnvelopeRequest

Properties

Name	Type	Required	Description
Name	string	✅	Name of the envelope
LegalityLevel	signplus.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	int64	❌	Unix timestamp of the expiration date
Comment	string	❌	Comment for the envelope
Sandbox	bool	❌	Whether the envelope is created in sandbox mode

TemplateRecipientRole

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

Name	Type	Required	Description
SIGNER	string	✅	“SIGNER”
RECEIVES_COPY	string	✅	“RECEIVES_COPY”
IN_PERSON_SIGNER	string	✅	“IN_PERSON_SIGNER”

ListWebhooksRequest

Properties

Name	Type	Required	Description
WebhookId	string	❌	ID of the webhook
Event	signplus.WebhookEvent	❌	Event of the webhook

AnnotationDateTimeFormat

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

Name	Type	Required	Description
DMY_NUMERIC_SLASH	string	✅	“DMY_NUMERIC_SLASH”
MDY_NUMERIC_SLASH	string	✅	“MDY_NUMERIC_SLASH”
YMD_NUMERIC_SLASH	string	✅	“YMD_NUMERIC_SLASH”
DMY_NUMERIC_DASH_SHORT	string	✅	“DMY_NUMERIC_DASH_SHORT”
DMY_NUMERIC_DASH	string	✅	“DMY_NUMERIC_DASH”
YMD_NUMERIC_DASH	string	✅	“YMD_NUMERIC_DASH”
MDY_TEXT_DASH_SHORT	string	✅	“MDY_TEXT_DASH_SHORT”
MDY_TEXT_SPACE_SHORT	string	✅	“MDY_TEXT_SPACE_SHORT”
MDY_TEXT_SPACE	string	✅	“MDY_TEXT_SPACE”

ListTemplateDocumentAnnotationsResponse

Properties

Name	Type	Required	Description
Annotations	[]signplus.Annotation	❌

AnnotationFontFamily

Font family of the text Properties

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

CreateTemplateRequest

Properties

Name	Type	Required	Description
Name	string	✅

AddTemplateDocumentRequest

Properties

Name	Type	Required	Description
File	any	✅	File to upload in binary format

SetEnvelopeExpirationRequest

Properties

Name	Type	Required	Description
ExpiresAt	int64	✅	Unix timestamp of the expiration date

SetEnvelopeLegalityLevelRequest

Properties

Name	Type	Required	Description
LegalityLevel	signplus.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)

ListTemplatesResponse

Properties

Name	Type	Required	Description
HasNextPage	bool	❌	Whether there is a next page
HasPreviousPage	bool	❌	Whether there is a previous page
Templates	[]signplus.Template	❌

SetTemplateCommentRequest

Properties

Name	Type	Required	Description
Comment	string	✅	Comment for the template

ListEnvelopesResponse

Properties

Name	Type	Required	Description
HasNextPage	bool	❌	Whether there is a next page
HasPreviousPage	bool	❌	Whether there is a previous page
Envelopes	[]signplus.Envelope	❌

ListTemplatesRequest

Properties

Name	Type	Required	Description
Name	string	❌	Name of the template
Tags	[]string	❌	List of tag templates
Ids	[]string	❌	List of templates IDs
First	int64	❌
Last	int64	❌
After	string	❌
Before	string	❌
OrderField	signplus.TemplateOrderField	❌	Field to order templates by
Ascending	bool	❌	Whether to order templates in ascending order

AnnotationFont

Properties

Name	Type	Required	Description
Family	signplus.AnnotationFontFamily	❌	Font family of the text
Italic	bool	❌	Whether the text is italic
Bold	bool	❌	Whether the text is bold

AnnotationType

Type of the annotation Properties

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

ListWebhooksResponse

Properties

Name	Type	Required	Description
Webhooks	[]signplus.Webhook	❌

Webhook

Properties

Name	Type	Required	Description
Id	string	❌	Unique identifier of the webhook
Event	signplus.WebhookEvent	❌	Event of the webhook
Target	string	❌	Target URL of the webhook

CreateEnvelopeFromTemplateRequest

Properties

Name	Type	Required	Description
Name	string	✅	Name of the envelope
Comment	string	❌	Comment for the envelope
Sandbox	bool	❌	Whether the envelope is created in sandbox mode

RecipientRole

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

Name	Type	Required	Description
SIGNER	string	✅	“SIGNER”
RECEIVES_COPY	string	✅	“RECEIVES_COPY”
IN_PERSON_SIGNER	string	✅	“IN_PERSON_SIGNER”

EnvelopeLegalityLevel

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

Name	Type	Required	Description
SES	string	✅	“SES”
QES_EIDAS	string	✅	“QES_EIDAS”
QES_ZERTES	string	✅	“QES_ZERTES”

ListTemplateDocumentsResponse

Properties

Name	Type	Required	Description
Documents	[]signplus.Document	❌

TemplateRecipient

Properties

Name	Type	Required	Description
Id	string	❌	Unique identifier of the recipient
Uid	string	❌	Unique identifier of the user associated with the recipient
Name	string	❌	Name of the recipient
Email	string	❌	Email of the recipient
Role	signplus.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)

RecipientVerification

Properties

Name	Type	Required	Description
Type_	signplus.RecipientVerificationType	❌	Type of signature verification (SMS sends a code via SMS, PASSCODE requires a code to be entered)
Value	string	❌

ListTemplateAnnotationsResponse

Properties

Name	Type	Required	Description
Annotations	[]signplus.Annotation	❌

Annotation

Properties

Name	Type	Required	Description
Id	string	❌	Unique identifier of the annotation
RecipientId	string	❌	ID of the recipient
DocumentId	string	❌	ID of the document
Page	int64	❌	Page number where the annotation is placed
X	float64	❌	X coordinate of the annotation (in % of the page width from 0 to 100) from the top left corner
Y	float64	❌	Y coordinate of the annotation (in % of the page height from 0 to 100) from the top left corner
Width	float64	❌	Width of the annotation (in % of the page width from 0 to 100)
Height	float64	❌	Height of the annotation (in % of the page height from 0 to 100)
Required	bool	❌	Whether the annotation is required
Type_	signplus.AnnotationType	❌	Type of the annotation
Signature	signplus.AnnotationSignature	❌	Signature annotation (null if annotation is not a signature)
Initials	signplus.AnnotationInitials	❌	Initials annotation (null if annotation is not initials)
Text	signplus.AnnotationText	❌	Text annotation (null if annotation is not a text)
Datetime	signplus.AnnotationDateTime	❌	Date annotation (null if annotation is not a date)
Checkbox	signplus.AnnotationCheckbox	❌	Checkbox annotation (null if annotation is not a checkbox)

ListEnvelopeDocumentsResponse

Properties

Name	Type	Required	Description
Documents	[]signplus.Document	❌

CreateWebhookRequest

Properties

Name	Type	Required	Description
Event	signplus.WebhookEvent	✅	Event of the webhook
Target	string	✅	URL of the webhook target

Page

Properties

Name	Type	Required	Description
Width	int64	❌	Width of the page in pixels
Height	int64	❌	Height of the page in pixels

Recipient

Properties

Name	Type	Required	Description
Name	string	✅	Name of the recipient
Email	string	✅	Email of the recipient
Role	signplus.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	signplus.RecipientVerification	❌

EnvelopeOrderField

Field to order envelopes by Properties

Name	Type	Required	Description
CREATION_DATE	string	✅	“CREATION_DATE”
MODIFICATION_DATE	string	✅	“MODIFICATION_DATE”
NAME	string	✅	“NAME”
STATUS	string	✅	“STATUS”
LAST_DOCUMENT_CHANGE	string	✅	“LAST_DOCUMENT_CHANGE”

SigningStep

Properties

Name	Type	Required	Description
Recipients	[]signplus.Recipient	❌	List of recipients

EnvelopeStatus

Status of the envelope Properties

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

ListEnvelopesRequest

Properties

Name	Type	Required	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	[]signplus.EnvelopeStatus	❌	List of envelope statuses
FolderIds	[]string	❌	List of folder IDs
OnlyRootFolder	bool	❌	Whether to only list envelopes in the root folder
DateFrom	int64	❌	Unix timestamp of the start date
DateTo	int64	❌	Unix timestamp of the end date
Uid	string	❌	Unique identifier of the user
First	int64	❌
Last	int64	❌
After	string	❌
Before	string	❌
OrderField	signplus.EnvelopeOrderField	❌	Field to order envelopes by
Ascending	bool	❌	Whether to order envelopes in ascending order
IncludeTrash	bool	❌	Whether to include envelopes in the trash

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”

TemplateOrderField

Field to order templates by Properties

Name	Type	Required	Description
TEMPLATE_ID	string	✅	“TEMPLATE_ID”
TEMPLATE_CREATION_DATE	string	✅	“TEMPLATE_CREATION_DATE”
TEMPLATE_MODIFICATION_DATE	string	✅	“TEMPLATE_MODIFICATION_DATE”
TEMPLATE_NAME	string	✅	“TEMPLATE_NAME”

AnnotationCheckbox

Checkbox annotation (null if annotation is not a checkbox) Properties

Name	Type	Required	Description
Checked	bool	❌	Whether the checkbox is checked
Style	signplus.AnnotationCheckboxStyle	❌	Style of the checkbox

AnnotationSignature

Signature annotation (null if annotation is not a signature) Properties

Name	Type	Required	Description
Id	string	❌	Unique identifier of the annotation signature

AddAnnotationRequest

Properties

Name	Type	Required	Description
DocumentId	string	✅	ID of the document
Page	int64	✅	Page number where the annotation is placed
X	float64	✅	X coordinate of the annotation (in % of the page width from 0 to 100) from the top left corner
Y	float64	✅	Y coordinate of the annotation (in % of the page height from 0 to 100) from the top left corner
Width	float64	✅	Width of the annotation (in % of the page width from 0 to 100)
Height	float64	✅	Height of the annotation (in % of the page height from 0 to 100)
Type_	signplus.AnnotationType	✅	Type of the annotation
RecipientId	string	❌	ID of the recipient
Required	bool	❌
Signature	signplus.AnnotationSignature	❌	Signature annotation (null if annotation is not a signature)
Initials	signplus.AnnotationInitials	❌	Initials annotation (null if annotation is not initials)
Text	signplus.AnnotationText	❌	Text annotation (null if annotation is not a text)
Datetime	signplus.AnnotationDateTime	❌	Date annotation (null if annotation is not a date)
Checkbox	signplus.AnnotationCheckbox	❌	Checkbox annotation (null if annotation is not a checkbox)

AnnotationDateTime

Date annotation (null if annotation is not a date) Properties

Name	Type	Required	Description
Size	float64	❌	Font size of the text in pt
Font	signplus.AnnotationFont	❌
Color	string	❌	Color of the text in hex format
AutoFill	bool	❌	Whether the date should be automatically filled
Timezone	string	❌	Timezone of the date
Timestamp	int64	❌	Unix timestamp of the date
Format	signplus.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)

AddEnvelopeDocumentRequest

Properties

Name	Type	Required	Description
File	any	❌	File to upload in binary format

EnvelopeNotification

Properties

Name	Type	Required	Description
Subject	string	❌	Subject of the notification
Message	string	❌	Message of the notification
ReminderInterval	int64	❌	Interval in days to send reminder

Get Started

Concepts

Guides

Backend SDKs

API Reference

​CreateEnvelope

​CreateEnvelopeFromTemplate

​ListEnvelopes

​GetEnvelope

​DeleteEnvelope

​GetEnvelopeDocument

​GetEnvelopeDocuments

​AddEnvelopeDocument

​SetEnvelopeDynamicFields

​AddEnvelopeSigningSteps

​SendEnvelope

​DuplicateEnvelope

​VoidEnvelope

​RenameEnvelope

​SetEnvelopeComment

​SetEnvelopeNotification

​SetEnvelopeExpirationDate

​SetEnvelopeLegalityLevel

​GetEnvelopeAnnotations

​GetEnvelopeDocumentAnnotations

​AddEnvelopeAnnotation

​DeleteEnvelopeAnnotation

​CreateTemplate

​ListTemplates

​GetTemplate

​DeleteTemplate

​DuplicateTemplate

​AddTemplateDocument

​GetTemplateDocument

​GetTemplateDocuments

​AddTemplateSigningSteps

​RenameTemplate

​SetTemplateComment

​SetTemplateNotification

​GetTemplateAnnotations

​GetDocumentTemplateAnnotations

​AddTemplateAnnotation

​DeleteTemplateAnnotation

​CreateWebhook

​ListWebhooks

​DeleteWebhook

​Models

​Document

​TemplateSigningStep

​ListEnvelopeDocumentAnnotationsResponse

​Template

​WebhookEvent

​RenameTemplateRequest

​AnnotationCheckboxStyle

​AnnotationInitials

​RenameEnvelopeRequest

​DynamicField

​SetEnvelopeDynamicFieldsRequest

​AddEnvelopeSigningStepsRequest

​EnvelopeFlowType

​SetEnvelopeCommentRequest

​AnnotationText

​Envelope

​AddTemplateSigningStepsRequest

​CreateEnvelopeRequest

​TemplateRecipientRole

​ListWebhooksRequest

​AnnotationDateTimeFormat

​ListTemplateDocumentAnnotationsResponse

​AnnotationFontFamily

​CreateTemplateRequest

​AddTemplateDocumentRequest

​SetEnvelopeExpirationRequest

​SetEnvelopeLegalityLevelRequest

​ListTemplatesResponse

​SetTemplateCommentRequest

​ListEnvelopesResponse

​ListTemplatesRequest

​AnnotationFont

​AnnotationType

CreateEnvelope

CreateEnvelopeFromTemplate

ListEnvelopes

GetEnvelope

DeleteEnvelope

GetEnvelopeDocument

GetEnvelopeDocuments

AddEnvelopeDocument

SetEnvelopeDynamicFields

AddEnvelopeSigningSteps

SendEnvelope

DuplicateEnvelope

VoidEnvelope

RenameEnvelope

SetEnvelopeComment

SetEnvelopeNotification

SetEnvelopeExpirationDate

SetEnvelopeLegalityLevel

GetEnvelopeAnnotations

GetEnvelopeDocumentAnnotations

AddEnvelopeAnnotation

DeleteEnvelopeAnnotation

CreateTemplate

ListTemplates

GetTemplate

DeleteTemplate

DuplicateTemplate

AddTemplateDocument

GetTemplateDocument

GetTemplateDocuments

AddTemplateSigningSteps

RenameTemplate

SetTemplateComment

SetTemplateNotification

GetTemplateAnnotations

GetDocumentTemplateAnnotations

AddTemplateAnnotation

DeleteTemplateAnnotation

CreateWebhook

ListWebhooks

DeleteWebhook

Models

Document

TemplateSigningStep

ListEnvelopeDocumentAnnotationsResponse

Template

WebhookEvent

RenameTemplateRequest

AnnotationCheckboxStyle

AnnotationInitials

RenameEnvelopeRequest

DynamicField

SetEnvelopeDynamicFieldsRequest

AddEnvelopeSigningStepsRequest

EnvelopeFlowType

SetEnvelopeCommentRequest

AnnotationText

Envelope

AddTemplateSigningStepsRequest

CreateEnvelopeRequest

TemplateRecipientRole

ListWebhooksRequest

AnnotationDateTimeFormat

ListTemplateDocumentAnnotationsResponse

AnnotationFontFamily

CreateTemplateRequest

AddTemplateDocumentRequest

SetEnvelopeExpirationRequest

SetEnvelopeLegalityLevelRequest

ListTemplatesResponse

SetTemplateCommentRequest

ListEnvelopesResponse

ListTemplatesRequest

AnnotationFont

AnnotationType

ListWebhooksResponse

Webhook

CreateEnvelopeFromTemplateRequest

RecipientRole

EnvelopeLegalityLevel