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

MethodsDescription
CreateEnvelopeCreate new envelope
CreateEnvelopeFromTemplateCreate new envelope from template
ListEnvelopesList envelopes
GetEnvelopeGet envelope
DeleteEnvelopeDelete envelope
GetEnvelopeDocumentGet envelope document
GetEnvelopeDocumentsGet envelope documents
AddEnvelopeDocumentAdd envelope document
SetEnvelopeDynamicFieldsSet envelope dynamic fields
AddEnvelopeSigningStepsAdd envelope signing steps
SendEnvelopeSend envelope for signature
DuplicateEnvelopeDuplicate envelope
VoidEnvelopeVoid envelope
RenameEnvelopeRename envelope
SetEnvelopeCommentSet envelope comment
SetEnvelopeNotificationSet envelope notification
SetEnvelopeExpirationDateSet envelope expiration date
SetEnvelopeLegalityLevelSet envelope legality level
GetEnvelopeAnnotationsGet envelope annotations
GetEnvelopeDocumentAnnotationsGet envelope document annotations
AddEnvelopeAnnotationAdd envelope annotation
DeleteEnvelopeAnnotationDelete envelope annotation
CreateTemplateCreate new template
ListTemplatesList templates
GetTemplateGet template
DeleteTemplateDelete template
DuplicateTemplateDuplicate template
AddTemplateDocumentAdd template document
GetTemplateDocumentGet template document
GetTemplateDocumentsGet template documents
AddTemplateSigningStepsAdd template signing steps
RenameTemplateRename template
SetTemplateCommentSet template comment
SetTemplateNotificationSet template notification
GetTemplateAnnotationsGet template annotations
GetDocumentTemplateAnnotationsGet document template annotations
AddTemplateAnnotationAdd template annotation
DeleteTemplateAnnotationDelete template annotation
CreateWebhookCreate webhook
ListWebhooksList webhooks
DeleteWebhookDelete webhook

​
CreateEnvelope

Create new envelope

  • HTTP Method: POST
  • Endpoint: /envelope

Parameters

NameTypeRequiredDescription
ctxContext✅Default go language context
createEnvelopeRequestCreateEnvelopeRequest✅

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

NameTypeRequiredDescription
ctxContext✅Default go language context
templateIdstring✅
createEnvelopeFromTemplateRequestCreateEnvelopeFromTemplateRequest✅

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

NameTypeRequiredDescription
ctxContext✅Default go language context
listEnvelopesRequestListEnvelopesRequest✅

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

NameTypeRequiredDescription
ctxContext✅Default go language context
envelopeIdstring✅

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

NameTypeRequiredDescription
ctxContext✅Default go language context
envelopeIdstring✅

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

NameTypeRequiredDescription
ctxContext✅Default go language context
envelopeIdstring✅
documentIdstring✅

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

NameTypeRequiredDescription
ctxContext✅Default go language context
envelopeIdstring✅

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

NameTypeRequiredDescription
ctxContext✅Default go language context
envelopeIdstring✅
addEnvelopeDocumentRequestAddEnvelopeDocumentRequest✅

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

NameTypeRequiredDescription
ctxContext✅Default go language context
envelopeIdstring✅
setEnvelopeDynamicFieldsRequestSetEnvelopeDynamicFieldsRequest✅

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

NameTypeRequiredDescription
ctxContext✅Default go language context
envelopeIdstring✅
addEnvelopeSigningStepsRequestAddEnvelopeSigningStepsRequest✅

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

NameTypeRequiredDescription
ctxContext✅Default go language context
envelopeIdstring✅

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

NameTypeRequiredDescription
ctxContext✅Default go language context
envelopeIdstring✅

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

NameTypeRequiredDescription
ctxContext✅Default go language context
envelopeIdstring✅

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

NameTypeRequiredDescription
ctxContext✅Default go language context
envelopeIdstring✅
renameEnvelopeRequestRenameEnvelopeRequest✅

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

NameTypeRequiredDescription
ctxContext✅Default go language context
envelopeIdstring✅
setEnvelopeCommentRequestSetEnvelopeCommentRequest✅

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

NameTypeRequiredDescription
ctxContext✅Default go language context
envelopeIdstring✅
envelopeNotificationEnvelopeNotification✅

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

NameTypeRequiredDescription
ctxContext✅Default go language context
envelopeIdstring✅
setEnvelopeExpirationRequestSetEnvelopeExpirationRequest✅

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

NameTypeRequiredDescription
ctxContext✅Default go language context
envelopeIdstring✅
setEnvelopeLegalityLevelRequestSetEnvelopeLegalityLevelRequest✅

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

NameTypeRequiredDescription
ctxContext✅Default go language context
envelopeIdstring✅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

NameTypeRequiredDescription
ctxContext✅Default go language context
envelopeIdstring✅ID of the envelope
documentIdstring✅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

NameTypeRequiredDescription
ctxContext✅Default go language context
envelopeIdstring✅ID of the envelope
addAnnotationRequestAddAnnotationRequest✅

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

NameTypeRequiredDescription
ctxContext✅Default go language context
envelopeIdstring✅ID of the envelope
annotationIdstring✅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

NameTypeRequiredDescription
ctxContext✅Default go language context
createTemplateRequestCreateTemplateRequest✅

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

NameTypeRequiredDescription
ctxContext✅Default go language context
listTemplatesRequestListTemplatesRequest✅

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

NameTypeRequiredDescription
ctxContext✅Default go language context
templateIdstring✅

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

NameTypeRequiredDescription
ctxContext✅Default go language context
templateIdstring✅

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

NameTypeRequiredDescription
ctxContext✅Default go language context
templateIdstring✅

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

NameTypeRequiredDescription
ctxContext✅Default go language context
templateIdstring✅
addTemplateDocumentRequestAddTemplateDocumentRequest✅

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

NameTypeRequiredDescription
ctxContext✅Default go language context
templateIdstring✅
documentIdstring✅

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

NameTypeRequiredDescription
ctxContext✅Default go language context
templateIdstring✅

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

NameTypeRequiredDescription
ctxContext✅Default go language context
templateIdstring✅
addTemplateSigningStepsRequestAddTemplateSigningStepsRequest✅

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

NameTypeRequiredDescription
ctxContext✅Default go language context
templateIdstring✅
renameTemplateRequestRenameTemplateRequest✅

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

NameTypeRequiredDescription
ctxContext✅Default go language context
templateIdstring✅
setTemplateCommentRequestSetTemplateCommentRequest✅

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

NameTypeRequiredDescription
ctxContext✅Default go language context
templateIdstring✅
envelopeNotificationEnvelopeNotification✅

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

NameTypeRequiredDescription
ctxContext✅Default go language context
templateIdstring✅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

NameTypeRequiredDescription
ctxContext✅Default go language context
templateIdstring✅ID of the template
documentIdstring✅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

NameTypeRequiredDescription
ctxContext✅Default go language context
templateIdstring✅ID of the template
addAnnotationRequestAddAnnotationRequest✅

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

NameTypeRequiredDescription
ctxContext✅Default go language context
templateIdstring✅ID of the template
annotationIdstring✅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

NameTypeRequiredDescription
ctxContext✅Default go language context
createWebhookRequestCreateWebhookRequest✅

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

NameTypeRequiredDescription
ctxContext✅Default go language context
listWebhooksRequestListWebhooksRequest✅

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

NameTypeRequiredDescription
ctxContext✅Default go language context
webhookIdstring✅

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

NameTypeRequiredDescription
Idstring❌Unique identifier of the document
Namestring❌Name of the document
Filenamestring❌Filename of the document
PageCountint64❌Number of pages in the document
Pages[]signplus.Page❌List of pages in the document

​
TemplateSigningStep

Properties

NameTypeRequiredDescription
Recipients[]signplus.TemplateRecipient❌List of recipients

​
ListEnvelopeDocumentAnnotationsResponse

Properties

NameTypeRequiredDescription
Annotations[]signplus.Annotation❌

​
Template

Properties

NameTypeRequiredDescription
Idstring❌Unique identifier of the template
Namestring❌Name of the template
Commentstring❌Comment for the template
Pagesint64❌Total number of pages in the template
LegalityLevelsignplus.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)
CreatedAtint64❌Unix timestamp of the creation date
UpdatedAtint64❌Unix timestamp of the last modification date
ExpirationDelayint64❌Expiration delay added to the current time when an envelope is created from this template
NumRecipientsint64❌Number of recipients in the envelope
SigningSteps[]signplus.TemplateSigningStep❌
Documents[]signplus.Document❌
Notificationsignplus.EnvelopeNotification❌
DynamicFields[]string❌List of dynamic fields

​
WebhookEvent

Event of the webhook

Properties

NameTypeRequiredDescription
ENVELOPE_EXPIREDstring✅“ENVELOPE_EXPIRED”
ENVELOPE_DECLINEDstring✅“ENVELOPE_DECLINED”
ENVELOPE_VOIDEDstring✅“ENVELOPE_VOIDED”
ENVELOPE_COMPLETEDstring✅“ENVELOPE_COMPLETED”
ENVELOPE_AUDIT_TRAILstring✅“ENVELOPE_AUDIT_TRAIL”

​
RenameTemplateRequest

Properties

NameTypeRequiredDescription
Namestring✅Name of the template

​
AnnotationCheckboxStyle

Style of the checkbox

Properties

NameTypeRequiredDescription
CIRCLE_CHECKstring✅“CIRCLE_CHECK”
CIRCLE_FULLstring✅“CIRCLE_FULL”
SQUARE_CHECKstring✅“SQUARE_CHECK”
SQUARE_FULLstring✅“SQUARE_FULL”
CHECK_MARKstring✅“CHECK_MARK”
TIMES_SQUAREstring✅“TIMES_SQUARE”

​
AnnotationInitials

Initials annotation (null if annotation is not initials)

Properties

NameTypeRequiredDescription
Idstring❌Unique identifier of the annotation initials

​
RenameEnvelopeRequest

Properties

NameTypeRequiredDescription
Namestring❌Name of the envelope

​
DynamicField

Properties

NameTypeRequiredDescription
Namestring❌Name of the dynamic field
Valuestring❌Value of the dynamic field

​
SetEnvelopeDynamicFieldsRequest

Properties

NameTypeRequiredDescription
DynamicFields[]signplus.DynamicField✅List of dynamic fields

​
AddEnvelopeSigningStepsRequest

Properties

NameTypeRequiredDescription
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

NameTypeRequiredDescription
REQUEST_SIGNATUREstring✅“REQUEST_SIGNATURE”
SIGN_MYSELFstring✅“SIGN_MYSELF”

​
SetEnvelopeCommentRequest

Properties

NameTypeRequiredDescription
Commentstring✅Comment for the envelope

​
AnnotationText

Text annotation (null if annotation is not a text)

Properties

NameTypeRequiredDescription
Sizefloat64❌Font size of the text in pt
Colorfloat64❌Text color in 32bit representation
Valuestring❌Text content of the annotation
Tooltipstring❌Tooltip of the annotation
DynamicFieldNamestring❌Name of the dynamic field
Fontsignplus.AnnotationFont❌

​
Envelope

Properties

NameTypeRequiredDescription
Idstring❌Unique identifier of the envelope
Namestring❌Name of the envelope
Commentstring❌Comment for the envelope
Pagesint64❌Total number of pages in the envelope
FlowTypesignplus.EnvelopeFlowType❌Flow type of the envelope (REQUEST_SIGNATURE is a request for signature, SIGN_MYSELF is a self-signing flow)
LegalityLevelsignplus.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)
Statussignplus.EnvelopeStatus❌Status of the envelope
CreatedAtint64❌Unix timestamp of the creation date
UpdatedAtint64❌Unix timestamp of the last modification date
ExpiresAtint64❌Unix timestamp of the expiration date
NumRecipientsint64❌Number of recipients in the envelope
IsDuplicablebool❌Whether the envelope can be duplicated
SigningSteps[]signplus.SigningStep❌
Documents[]signplus.Document❌
Notificationsignplus.EnvelopeNotification❌

​
AddTemplateSigningStepsRequest

Properties

NameTypeRequiredDescription
SigningSteps[]signplus.TemplateSigningStep✅List of signing steps

​
CreateEnvelopeRequest

Properties

NameTypeRequiredDescription
Namestring✅Name of the envelope
LegalityLevelsignplus.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)
ExpiresAtint64❌Unix timestamp of the expiration date
Commentstring❌Comment for the envelope
Sandboxbool❌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

NameTypeRequiredDescription
SIGNERstring✅“SIGNER”
RECEIVES_COPYstring✅“RECEIVES_COPY”
IN_PERSON_SIGNERstring✅“IN_PERSON_SIGNER”

​
ListWebhooksRequest

Properties

NameTypeRequiredDescription
WebhookIdstring❌ID of the webhook
Eventsignplus.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

NameTypeRequiredDescription
DMY_NUMERIC_SLASHstring✅“DMY_NUMERIC_SLASH”
MDY_NUMERIC_SLASHstring✅“MDY_NUMERIC_SLASH”
YMD_NUMERIC_SLASHstring✅“YMD_NUMERIC_SLASH”
DMY_NUMERIC_DASH_SHORTstring✅“DMY_NUMERIC_DASH_SHORT”
DMY_NUMERIC_DASHstring✅“DMY_NUMERIC_DASH”
YMD_NUMERIC_DASHstring✅“YMD_NUMERIC_DASH”
MDY_TEXT_DASH_SHORTstring✅“MDY_TEXT_DASH_SHORT”
MDY_TEXT_SPACE_SHORTstring✅“MDY_TEXT_SPACE_SHORT”
MDY_TEXT_SPACEstring✅“MDY_TEXT_SPACE”

​
ListTemplateDocumentAnnotationsResponse

Properties

NameTypeRequiredDescription
Annotations[]signplus.Annotation❌

​
AnnotationFontFamily

Font family of the text

Properties

NameTypeRequiredDescription
UNKNOWNstring✅“UNKNOWN”
SERIFstring✅“SERIF”
SANSstring✅“SANS”
MONOstring✅“MONO”

​
CreateTemplateRequest

Properties

NameTypeRequiredDescription
Namestring✅

​
AddTemplateDocumentRequest

Properties

NameTypeRequiredDescription
Fileany✅File to upload in binary format

​
SetEnvelopeExpirationRequest

Properties

NameTypeRequiredDescription
ExpiresAtint64✅Unix timestamp of the expiration date

​
SetEnvelopeLegalityLevelRequest

Properties

NameTypeRequiredDescription
LegalityLevelsignplus.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

NameTypeRequiredDescription
HasNextPagebool❌Whether there is a next page
HasPreviousPagebool❌Whether there is a previous page
Templates[]signplus.Template❌

​
SetTemplateCommentRequest

Properties

NameTypeRequiredDescription
Commentstring✅Comment for the template

​
ListEnvelopesResponse

Properties

NameTypeRequiredDescription
HasNextPagebool❌Whether there is a next page
HasPreviousPagebool❌Whether there is a previous page
Envelopes[]signplus.Envelope❌

​
ListTemplatesRequest

Properties

NameTypeRequiredDescription
Namestring❌Name of the template
Tags[]string❌List of tag templates
Ids[]string❌List of templates IDs
Firstint64❌
Lastint64❌
Afterstring❌
Beforestring❌
OrderFieldsignplus.TemplateOrderField❌Field to order templates by
Ascendingbool❌Whether to order templates in ascending order

​
AnnotationFont

Properties

NameTypeRequiredDescription
Familysignplus.AnnotationFontFamily❌Font family of the text
Italicbool❌Whether the text is italic
Boldbool❌Whether the text is bold

​
AnnotationType

Type of the annotation

Properties

NameTypeRequiredDescription
TEXTstring✅“TEXT”
SIGNATUREstring✅“SIGNATURE”
INITIALSstring✅“INITIALS”
CHECKBOXstring✅“CHECKBOX”
DATEstring✅“DATE”

​
ListWebhooksResponse

Properties

NameTypeRequiredDescription
Webhooks[]signplus.Webhook❌

​
Webhook

Properties

NameTypeRequiredDescription
Idstring❌Unique identifier of the webhook
Eventsignplus.WebhookEvent❌Event of the webhook
Targetstring❌Target URL of the webhook

​
CreateEnvelopeFromTemplateRequest

Properties

NameTypeRequiredDescription
Namestring✅Name of the envelope
Commentstring❌Comment for the envelope
Sandboxbool❌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

NameTypeRequiredDescription
SIGNERstring✅“SIGNER”
RECEIVES_COPYstring✅“RECEIVES_COPY”
IN_PERSON_SIGNERstring✅“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

NameTypeRequiredDescription
SESstring✅“SES”
QES_EIDASstring✅“QES_EIDAS”
QES_ZERTESstring✅“QES_ZERTES”

​
ListTemplateDocumentsResponse

Properties

NameTypeRequiredDescription
Documents[]signplus.Document❌

​
TemplateRecipient

Properties

NameTypeRequiredDescription
Idstring❌Unique identifier of the recipient
Uidstring❌Unique identifier of the user associated with the recipient
Namestring❌Name of the recipient
Emailstring❌Email of the recipient
Rolesignplus.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

NameTypeRequiredDescription
Type_signplus.RecipientVerificationType❌Type of signature verification (SMS sends a code via SMS, PASSCODE requires a code to be entered)
Valuestring❌

​
ListTemplateAnnotationsResponse

Properties

NameTypeRequiredDescription
Annotations[]signplus.Annotation❌

​
Annotation

Properties

NameTypeRequiredDescription
Idstring❌Unique identifier of the annotation
RecipientIdstring❌ID of the recipient
DocumentIdstring❌ID of the document
Pageint64❌Page number where the annotation is placed
Xfloat64❌X coordinate of the annotation (in % of the page width from 0 to 100) from the top left corner
Yfloat64❌Y coordinate of the annotation (in % of the page height from 0 to 100) from the top left corner
Widthfloat64❌Width of the annotation (in % of the page width from 0 to 100)
Heightfloat64❌Height of the annotation (in % of the page height from 0 to 100)
Requiredbool❌Whether the annotation is required
Type_signplus.AnnotationType❌Type of the annotation
Signaturesignplus.AnnotationSignature❌Signature annotation (null if annotation is not a signature)
Initialssignplus.AnnotationInitials❌Initials annotation (null if annotation is not initials)
Textsignplus.AnnotationText❌Text annotation (null if annotation is not a text)
Datetimesignplus.AnnotationDateTime❌Date annotation (null if annotation is not a date)
Checkboxsignplus.AnnotationCheckbox❌Checkbox annotation (null if annotation is not a checkbox)

​
ListEnvelopeDocumentsResponse

Properties

NameTypeRequiredDescription
Documents[]signplus.Document❌

​
CreateWebhookRequest

Properties

NameTypeRequiredDescription
Eventsignplus.WebhookEvent✅Event of the webhook
Targetstring✅URL of the webhook target

​
Page

Properties

NameTypeRequiredDescription
Widthint64❌Width of the page in pixels
Heightint64❌Height of the page in pixels

​
Recipient

Properties

NameTypeRequiredDescription
Namestring✅Name of the recipient
Emailstring✅Email of the recipient
Rolesignplus.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)
Idstring❌Unique identifier of the recipient
Uidstring❌Unique identifier of the user associated with the recipient
Verificationsignplus.RecipientVerification❌

​
EnvelopeOrderField

Field to order envelopes by

Properties

NameTypeRequiredDescription
CREATION_DATEstring✅“CREATION_DATE”
MODIFICATION_DATEstring✅“MODIFICATION_DATE”
NAMEstring✅“NAME”
STATUSstring✅“STATUS”
LAST_DOCUMENT_CHANGEstring✅“LAST_DOCUMENT_CHANGE”

​
SigningStep

Properties

NameTypeRequiredDescription
Recipients[]signplus.Recipient❌List of recipients

​
EnvelopeStatus

Status of the envelope

Properties

NameTypeRequiredDescription
DRAFTstring✅“DRAFT”
IN_PROGRESSstring✅“IN_PROGRESS”
COMPLETEDstring✅“COMPLETED”
EXPIREDstring✅“EXPIRED”
DECLINEDstring✅“DECLINED”
VOIDEDstring✅“VOIDED”
PENDINGstring✅“PENDING”

​
ListEnvelopesRequest

Properties

NameTypeRequiredDescription
Namestring❌Name of the envelope
Tags[]string❌List of tags
Commentstring❌Comment of the envelope
Ids[]string❌List of envelope IDs
Statuses[]signplus.EnvelopeStatus❌List of envelope statuses
FolderIds[]string❌List of folder IDs
OnlyRootFolderbool❌Whether to only list envelopes in the root folder
DateFromint64❌Unix timestamp of the start date
DateToint64❌Unix timestamp of the end date
Uidstring❌Unique identifier of the user
Firstint64❌
Lastint64❌
Afterstring❌
Beforestring❌
OrderFieldsignplus.EnvelopeOrderField❌Field to order envelopes by
Ascendingbool❌Whether to order envelopes in ascending order
IncludeTrashbool❌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

NameTypeRequiredDescription
SMSstring✅“SMS”
PASSCODEstring✅“PASSCODE”

​
TemplateOrderField

Field to order templates by

Properties

NameTypeRequiredDescription
TEMPLATE_IDstring✅“TEMPLATE_ID”
TEMPLATE_CREATION_DATEstring✅“TEMPLATE_CREATION_DATE”
TEMPLATE_MODIFICATION_DATEstring✅“TEMPLATE_MODIFICATION_DATE”
TEMPLATE_NAMEstring✅“TEMPLATE_NAME”

​
AnnotationCheckbox

Checkbox annotation (null if annotation is not a checkbox)

Properties

NameTypeRequiredDescription
Checkedbool❌Whether the checkbox is checked
Stylesignplus.AnnotationCheckboxStyle❌Style of the checkbox

​
AnnotationSignature

Signature annotation (null if annotation is not a signature)

Properties

NameTypeRequiredDescription
Idstring❌Unique identifier of the annotation signature

​
AddAnnotationRequest

Properties

NameTypeRequiredDescription
DocumentIdstring✅ID of the document
Pageint64✅Page number where the annotation is placed
Xfloat64✅X coordinate of the annotation (in % of the page width from 0 to 100) from the top left corner
Yfloat64✅Y coordinate of the annotation (in % of the page height from 0 to 100) from the top left corner
Widthfloat64✅Width of the annotation (in % of the page width from 0 to 100)
Heightfloat64✅Height of the annotation (in % of the page height from 0 to 100)
Type_signplus.AnnotationType✅Type of the annotation
RecipientIdstring❌ID of the recipient
Requiredbool❌
Signaturesignplus.AnnotationSignature❌Signature annotation (null if annotation is not a signature)
Initialssignplus.AnnotationInitials❌Initials annotation (null if annotation is not initials)
Textsignplus.AnnotationText❌Text annotation (null if annotation is not a text)
Datetimesignplus.AnnotationDateTime❌Date annotation (null if annotation is not a date)
Checkboxsignplus.AnnotationCheckbox❌Checkbox annotation (null if annotation is not a checkbox)

​
AnnotationDateTime

Date annotation (null if annotation is not a date)

Properties

NameTypeRequiredDescription
Sizefloat64❌Font size of the text in pt
Fontsignplus.AnnotationFont❌
Colorstring❌Color of the text in hex format
AutoFillbool❌Whether the date should be automatically filled
Timezonestring❌Timezone of the date
Timestampint64❌Unix timestamp of the date
Formatsignplus.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

NameTypeRequiredDescription
Fileany❌File to upload in binary format

​
EnvelopeNotification

Properties

NameTypeRequiredDescription
Subjectstring❌Subject of the notification
Messagestring❌Message of the notification
ReminderIntervalint64❌Interval in days to send reminder
InstallInstall