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 |
DownloadEnvelopeSignedDocuments | Download signed documents for an envelope |
DownloadEnvelopeCertificate | Download certificate of completion for an envelope |
GetEnvelopeDocument | Get envelope document |
GetEnvelopeDocuments | Get envelope documents |
AddEnvelopeDocument | Add envelope document |
SetEnvelopeDynamicFields | Set envelope dynamic fields |
AddEnvelopeSigningSteps | Add envelope signing steps |
SetEnvelopeAttachmentsSettings | Set envelope attachment settings |
SetEnvelopeAttachmentsPlaceholders | Placeholders to be set, completely replacing the existing ones. |
GetAttachmentFile | Get envelope attachment file |
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 |
SetTemplateAttachmentsSettings | Set template attachment settings |
SetTemplateAttachmentsPlaceholders | Placeholders to be set, completely replacing the existing ones. |
CreateWebhook | Create webhook |
ListWebhooks | List webhooks |
DeleteWebhook | Delete webhook |
CreateEnvelope
Create new envelope- HTTP Method:
POST
- Endpoint:
/envelope
Name | Type | Required | Description |
---|---|---|---|
ctx | Context | ✅ | Default go language context |
createEnvelopeRequest | CreateEnvelopeRequest | ✅ |
Envelope
Example Usage Code Snippet
CreateEnvelopeFromTemplate
Create new envelope from template- HTTP Method:
POST
- Endpoint:
/envelope/from_template/{template_id}
Name | Type | Required | Description |
---|---|---|---|
ctx | Context | ✅ | Default go language context |
templateId | string | ✅ | |
createEnvelopeFromTemplateRequest | CreateEnvelopeFromTemplateRequest | ✅ |
Envelope
Example Usage Code Snippet
ListEnvelopes
List envelopes- HTTP Method:
POST
- Endpoint:
/envelopes
Name | Type | Required | Description |
---|---|---|---|
ctx | Context | ✅ | Default go language context |
listEnvelopesRequest | ListEnvelopesRequest | ✅ |
ListEnvelopesResponse
Example Usage Code Snippet
GetEnvelope
Get envelope- HTTP Method:
GET
- Endpoint:
/envelope/{envelope_id}
Name | Type | Required | Description |
---|---|---|---|
ctx | Context | ✅ | Default go language context |
envelopeId | string | ✅ |
Envelope
Example Usage Code Snippet
DeleteEnvelope
Delete envelope- HTTP Method:
DELETE
- Endpoint:
/envelope/{envelope_id}
Name | Type | Required | Description |
---|---|---|---|
ctx | Context | ✅ | Default go language context |
envelopeId | string | ✅ |
any
Example Usage Code Snippet
DownloadEnvelopeSignedDocuments
Download signed documents for an envelope- HTTP Method:
GET
- Endpoint:
/envelope/{envelope_id}/signed_documents
Name | Type | Required | Description |
---|---|---|---|
ctx | Context | ✅ | Default go language context |
envelopeId | string | ✅ | ID of the envelope |
params | DownloadEnvelopeSignedDocumentsRequestParams | ✅ | Additional request parameters |
[]byte
Example Usage Code Snippet
DownloadEnvelopeCertificate
Download certificate of completion for an envelope- HTTP Method:
GET
- Endpoint:
/envelope/{envelope_id}/certificate
Name | Type | Required | Description |
---|---|---|---|
ctx | Context | ✅ | Default go language context |
envelopeId | string | ✅ | ID of the envelope |
[]byte
Example Usage Code Snippet
GetEnvelopeDocument
Get envelope document- HTTP Method:
GET
- Endpoint:
/envelope/{envelope_id}/document/{document_id}
Name | Type | Required | Description |
---|---|---|---|
ctx | Context | ✅ | Default go language context |
envelopeId | string | ✅ | |
documentId | string | ✅ |
Document
Example Usage Code Snippet
GetEnvelopeDocuments
Get envelope documents- HTTP Method:
GET
- Endpoint:
/envelope/{envelope_id}/documents
Name | Type | Required | Description |
---|---|---|---|
ctx | Context | ✅ | Default go language context |
envelopeId | string | ✅ |
ListEnvelopeDocumentsResponse
Example Usage Code Snippet
AddEnvelopeDocument
Add envelope document- HTTP Method:
POST
- Endpoint:
/envelope/{envelope_id}/document
Name | Type | Required | Description |
---|---|---|---|
ctx | Context | ✅ | Default go language context |
envelopeId | string | ✅ | |
addEnvelopeDocumentRequest | AddEnvelopeDocumentRequest | ✅ |
Document
Example Usage Code Snippet
SetEnvelopeDynamicFields
Set envelope dynamic fields- HTTP Method:
PUT
- Endpoint:
/envelope/{envelope_id}/dynamic_fields
Name | Type | Required | Description |
---|---|---|---|
ctx | Context | ✅ | Default go language context |
envelopeId | string | ✅ | |
setEnvelopeDynamicFieldsRequest | SetEnvelopeDynamicFieldsRequest | ✅ |
Envelope
Example Usage Code Snippet
AddEnvelopeSigningSteps
Add envelope signing steps- HTTP Method:
POST
- Endpoint:
/envelope/{envelope_id}/signing_steps
Name | Type | Required | Description |
---|---|---|---|
ctx | Context | ✅ | Default go language context |
envelopeId | string | ✅ | |
addEnvelopeSigningStepsRequest | AddEnvelopeSigningStepsRequest | ✅ |
Envelope
Example Usage Code Snippet
SetEnvelopeAttachmentsSettings
Set envelope attachment settings- HTTP Method:
PUT
- Endpoint:
/envelope/{envelope_id}/attachments/settings
Name | Type | Required | Description |
---|---|---|---|
ctx | Context | ✅ | Default go language context |
envelopeId | string | ✅ | |
setEnvelopeAttachmentsSettingsRequest | SetEnvelopeAttachmentsSettingsRequest | ✅ |
EnvelopeAttachments
Example Usage Code Snippet
SetEnvelopeAttachmentsPlaceholders
Placeholders to be set, completely replacing the existing ones.- HTTP Method:
PUT
- Endpoint:
/envelope/{envelope_id}/attachments/placeholders
Name | Type | Required | Description |
---|---|---|---|
ctx | Context | ✅ | Default go language context |
envelopeId | string | ✅ | |
setEnvelopeAttachmentsPlaceholdersRequest | SetEnvelopeAttachmentsPlaceholdersRequest | ✅ |
EnvelopeAttachments
Example Usage Code Snippet
GetAttachmentFile
Get envelope attachment file- HTTP Method:
GET
- Endpoint:
/envelope/{envelope_id}/attachments/{file_id}
Name | Type | Required | Description |
---|---|---|---|
ctx | Context | ✅ | Default go language context |
envelopeId | string | ✅ | |
fileId | string | ✅ |
[]byte
Example Usage Code Snippet
SendEnvelope
Send envelope for signature- HTTP Method:
POST
- Endpoint:
/envelope/{envelope_id}/send
Name | Type | Required | Description |
---|---|---|---|
ctx | Context | ✅ | Default go language context |
envelopeId | string | ✅ |
Envelope
Example Usage Code Snippet
DuplicateEnvelope
Duplicate envelope- HTTP Method:
POST
- Endpoint:
/envelope/{envelope_id}/duplicate
Name | Type | Required | Description |
---|---|---|---|
ctx | Context | ✅ | Default go language context |
envelopeId | string | ✅ |
Envelope
Example Usage Code Snippet
VoidEnvelope
Void envelope- HTTP Method:
PUT
- Endpoint:
/envelope/{envelope_id}/void
Name | Type | Required | Description |
---|---|---|---|
ctx | Context | ✅ | Default go language context |
envelopeId | string | ✅ |
Envelope
Example Usage Code Snippet
RenameEnvelope
Rename envelope- HTTP Method:
PUT
- Endpoint:
/envelope/{envelope_id}/rename
Name | Type | Required | Description |
---|---|---|---|
ctx | Context | ✅ | Default go language context |
envelopeId | string | ✅ | |
renameEnvelopeRequest | RenameEnvelopeRequest | ✅ |
Envelope
Example Usage Code Snippet
SetEnvelopeComment
Set envelope comment- HTTP Method:
PUT
- Endpoint:
/envelope/{envelope_id}/set_comment
Name | Type | Required | Description |
---|---|---|---|
ctx | Context | ✅ | Default go language context |
envelopeId | string | ✅ | |
setEnvelopeCommentRequest | SetEnvelopeCommentRequest | ✅ |
Envelope
Example Usage Code Snippet
SetEnvelopeNotification
Set envelope notification- HTTP Method:
PUT
- Endpoint:
/envelope/{envelope_id}/set_notification
Name | Type | Required | Description |
---|---|---|---|
ctx | Context | ✅ | Default go language context |
envelopeId | string | ✅ | |
envelopeNotification | EnvelopeNotification | ✅ |
Envelope
Example Usage Code Snippet
SetEnvelopeExpirationDate
Set envelope expiration date- HTTP Method:
PUT
- Endpoint:
/envelope/{envelope_id}/set_expiration_date
Name | Type | Required | Description |
---|---|---|---|
ctx | Context | ✅ | Default go language context |
envelopeId | string | ✅ | |
setEnvelopeExpirationRequest | SetEnvelopeExpirationRequest | ✅ |
Envelope
Example Usage Code Snippet
SetEnvelopeLegalityLevel
Set envelope legality level- HTTP Method:
PUT
- Endpoint:
/envelope/{envelope_id}/set_legality_level
Name | Type | Required | Description |
---|---|---|---|
ctx | Context | ✅ | Default go language context |
envelopeId | string | ✅ | |
setEnvelopeLegalityLevelRequest | SetEnvelopeLegalityLevelRequest | ✅ |
Envelope
Example Usage Code Snippet
GetEnvelopeAnnotations
Get envelope annotations- HTTP Method:
GET
- Endpoint:
/envelope/{envelope_id}/annotations
Name | Type | Required | Description |
---|---|---|---|
ctx | Context | ✅ | Default go language context |
envelopeId | string | ✅ | ID of the envelope |
[]Annotation
Example Usage Code Snippet
GetEnvelopeDocumentAnnotations
Get envelope document annotations- HTTP Method:
GET
- Endpoint:
/envelope/{envelope_id}/annotations/{document_id}
Name | Type | Required | Description |
---|---|---|---|
ctx | Context | ✅ | Default go language context |
envelopeId | string | ✅ | ID of the envelope |
documentId | string | ✅ | ID of document |
ListEnvelopeDocumentAnnotationsResponse
Example Usage Code Snippet
AddEnvelopeAnnotation
Add envelope annotation- HTTP Method:
POST
- Endpoint:
/envelope/{envelope_id}/annotation
Name | Type | Required | Description |
---|---|---|---|
ctx | Context | ✅ | Default go language context |
envelopeId | string | ✅ | ID of the envelope |
addAnnotationRequest | AddAnnotationRequest | ✅ |
Annotation
Example Usage Code Snippet
DeleteEnvelopeAnnotation
Delete envelope annotation- HTTP Method:
DELETE
- Endpoint:
/envelope/{envelope_id}/annotation/{annotation_id}
Name | Type | Required | Description |
---|---|---|---|
ctx | Context | ✅ | Default go language context |
envelopeId | string | ✅ | ID of the envelope |
annotationId | string | ✅ | ID of the annotation to delete |
any
Example Usage Code Snippet
CreateTemplate
Create new template- HTTP Method:
POST
- Endpoint:
/template
Name | Type | Required | Description |
---|---|---|---|
ctx | Context | ✅ | Default go language context |
createTemplateRequest | CreateTemplateRequest | ✅ |
Template
Example Usage Code Snippet
ListTemplates
List templates- HTTP Method:
POST
- Endpoint:
/templates
Name | Type | Required | Description |
---|---|---|---|
ctx | Context | ✅ | Default go language context |
listTemplatesRequest | ListTemplatesRequest | ✅ |
ListTemplatesResponse
Example Usage Code Snippet
GetTemplate
Get template- HTTP Method:
GET
- Endpoint:
/template/{template_id}
Name | Type | Required | Description |
---|---|---|---|
ctx | Context | ✅ | Default go language context |
templateId | string | ✅ |
Template
Example Usage Code Snippet
DeleteTemplate
Delete template- HTTP Method:
DELETE
- Endpoint:
/template/{template_id}
Name | Type | Required | Description |
---|---|---|---|
ctx | Context | ✅ | Default go language context |
templateId | string | ✅ |
any
Example Usage Code Snippet
DuplicateTemplate
Duplicate template- HTTP Method:
POST
- Endpoint:
/template/{template_id}/duplicate
Name | Type | Required | Description |
---|---|---|---|
ctx | Context | ✅ | Default go language context |
templateId | string | ✅ |
Template
Example Usage Code Snippet
AddTemplateDocument
Add template document- HTTP Method:
POST
- Endpoint:
/template/{template_id}/document
Name | Type | Required | Description |
---|---|---|---|
ctx | Context | ✅ | Default go language context |
templateId | string | ✅ | |
addTemplateDocumentRequest | AddTemplateDocumentRequest | ✅ |
Document
Example Usage Code Snippet
GetTemplateDocument
Get template document- HTTP Method:
GET
- Endpoint:
/template/{template_id}/document/{document_id}
Name | Type | Required | Description |
---|---|---|---|
ctx | Context | ✅ | Default go language context |
templateId | string | ✅ | |
documentId | string | ✅ |
Document
Example Usage Code Snippet
GetTemplateDocuments
Get template documents- HTTP Method:
GET
- Endpoint:
/template/{template_id}/documents
Name | Type | Required | Description |
---|---|---|---|
ctx | Context | ✅ | Default go language context |
templateId | string | ✅ |
ListTemplateDocumentsResponse
Example Usage Code Snippet
AddTemplateSigningSteps
Add template signing steps- HTTP Method:
POST
- Endpoint:
/template/{template_id}/signing_steps
Name | Type | Required | Description |
---|---|---|---|
ctx | Context | ✅ | Default go language context |
templateId | string | ✅ | |
addTemplateSigningStepsRequest | AddTemplateSigningStepsRequest | ✅ |
Template
Example Usage Code Snippet
RenameTemplate
Rename template- HTTP Method:
PUT
- Endpoint:
/template/{template_id}/rename
Name | Type | Required | Description |
---|---|---|---|
ctx | Context | ✅ | Default go language context |
templateId | string | ✅ | |
renameTemplateRequest | RenameTemplateRequest | ✅ |
Template
Example Usage Code Snippet
SetTemplateComment
Set template comment- HTTP Method:
PUT
- Endpoint:
/template/{template_id}/set_comment
Name | Type | Required | Description |
---|---|---|---|
ctx | Context | ✅ | Default go language context |
templateId | string | ✅ | |
setTemplateCommentRequest | SetTemplateCommentRequest | ✅ |
Template
Example Usage Code Snippet
SetTemplateNotification
Set template notification- HTTP Method:
PUT
- Endpoint:
/template/{template_id}/set_notification
Name | Type | Required | Description |
---|---|---|---|
ctx | Context | ✅ | Default go language context |
templateId | string | ✅ | |
envelopeNotification | EnvelopeNotification | ✅ |
Template
Example Usage Code Snippet
GetTemplateAnnotations
Get template annotations- HTTP Method:
GET
- Endpoint:
/template/{template_id}/annotations
Name | Type | Required | Description |
---|---|---|---|
ctx | Context | ✅ | Default go language context |
templateId | string | ✅ | ID of the template |
ListTemplateAnnotationsResponse
Example Usage Code Snippet
GetDocumentTemplateAnnotations
Get document template annotations- HTTP Method:
GET
- Endpoint:
/template/{template_id}/annotations/{document_id}
Name | Type | Required | Description |
---|---|---|---|
ctx | Context | ✅ | Default go language context |
templateId | string | ✅ | ID of the template |
documentId | string | ✅ | ID of document |
ListTemplateDocumentAnnotationsResponse
Example Usage Code Snippet
AddTemplateAnnotation
Add template annotation- HTTP Method:
POST
- Endpoint:
/template/{template_id}/annotation
Name | Type | Required | Description |
---|---|---|---|
ctx | Context | ✅ | Default go language context |
templateId | string | ✅ | ID of the template |
addAnnotationRequest | AddAnnotationRequest | ✅ |
Annotation
Example Usage Code Snippet
DeleteTemplateAnnotation
Delete template annotation- HTTP Method:
DELETE
- Endpoint:
/template/{template_id}/annotation/{annotation_id}
Name | Type | Required | Description |
---|---|---|---|
ctx | Context | ✅ | Default go language context |
templateId | string | ✅ | ID of the template |
annotationId | string | ✅ | ID of the annotation to delete |
any
Example Usage Code Snippet
SetTemplateAttachmentsSettings
Set template attachment settings- HTTP Method:
PUT
- Endpoint:
/template/{template_id}/attachments/settings
Name | Type | Required | Description |
---|---|---|---|
ctx | Context | ✅ | Default go language context |
templateId | string | ✅ | |
setEnvelopeAttachmentsSettingsRequest | SetEnvelopeAttachmentsSettingsRequest | ✅ |
EnvelopeAttachments
Example Usage Code Snippet
SetTemplateAttachmentsPlaceholders
Placeholders to be set, completely replacing the existing ones.- HTTP Method:
PUT
- Endpoint:
/template/{template_id}/attachments/placeholders
Name | Type | Required | Description |
---|---|---|---|
ctx | Context | ✅ | Default go language context |
templateId | string | ✅ | |
setEnvelopeAttachmentsPlaceholdersRequest | SetEnvelopeAttachmentsPlaceholdersRequest | ✅ |
EnvelopeAttachments
Example Usage Code Snippet
CreateWebhook
Create webhook- HTTP Method:
POST
- Endpoint:
/webhook
Name | Type | Required | Description |
---|---|---|---|
ctx | Context | ✅ | Default go language context |
createWebhookRequest | CreateWebhookRequest | ✅ |
Webhook
Example Usage Code Snippet
ListWebhooks
List webhooks- HTTP Method:
POST
- Endpoint:
/webhooks
Name | Type | Required | Description |
---|---|---|---|
ctx | Context | ✅ | Default go language context |
listWebhooksRequest | ListWebhooksRequest | ✅ |
ListWebhooksResponse
Example Usage Code Snippet
DeleteWebhook
Delete webhook- HTTP Method:
DELETE
- Endpoint:
/webhook/{webhook_id}
Name | Type | Required | Description |
---|---|---|---|
ctx | Context | ✅ | Default go language context |
webhookId | string | ✅ |
any
Example Usage Code Snippet
Models
Document
PropertiesName | 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 |
SetEnvelopeAttachmentsSettingsRequest
PropertiesName | Type | Required | Description |
---|---|---|---|
Settings | signplus.AttachmentSettings | ✅ |
TemplateSigningStep
PropertiesName | Type | Required | Description |
---|---|---|---|
Recipients | []signplus.TemplateRecipient | ❌ | List of recipients |
ListEnvelopeDocumentAnnotationsResponse
PropertiesName | Type | Required | Description |
---|---|---|---|
Annotations | []signplus.Annotation | ❌ |
Template
PropertiesName | 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 |
Attachments | signplus.EnvelopeAttachments | ❌ |
WebhookEvent
Event of the webhook PropertiesName | 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
PropertiesName | Type | Required | Description |
---|---|---|---|
Name | string | ✅ | Name of the template |
AnnotationCheckboxStyle
Style of the checkbox PropertiesName | 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) PropertiesName | Type | Required | Description |
---|---|---|---|
Id | string | ❌ | Unique identifier of the annotation initials |
AttachmentPlaceholderFile
PropertiesName | Type | Required | Description |
---|---|---|---|
Id | string | ❌ | ID of the file |
Name | string | ❌ | Name of the file |
Size | int64 | ❌ | Size of the file in bytes |
Mimetype | string | ❌ | MIME type of the file |
RenameEnvelopeRequest
PropertiesName | Type | Required | Description |
---|---|---|---|
Name | string | ❌ | Name of the envelope |
DynamicField
PropertiesName | Type | Required | Description |
---|---|---|---|
Name | string | ❌ | Name of the dynamic field |
Value | string | ❌ | Value of the dynamic field |
SetEnvelopeDynamicFieldsRequest
PropertiesName | Type | Required | Description |
---|---|---|---|
DynamicFields | []signplus.DynamicField | ✅ | List of dynamic fields |
AddEnvelopeSigningStepsRequest
PropertiesName | 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) PropertiesName | Type | Required | Description |
---|---|---|---|
REQUEST_SIGNATURE | string | ✅ | “REQUEST_SIGNATURE” |
SIGN_MYSELF | string | ✅ | “SIGN_MYSELF” |
SetEnvelopeCommentRequest
PropertiesName | Type | Required | Description |
---|---|---|---|
Comment | string | ✅ | Comment for the envelope |
AnnotationText
Text annotation (null if annotation is not a text) PropertiesName | 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
PropertiesName | 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 | ❌ | |
Attachments | signplus.EnvelopeAttachments | ❌ |
AddTemplateSigningStepsRequest
PropertiesName | Type | Required | Description |
---|---|---|---|
SigningSteps | []signplus.TemplateSigningStep | ✅ | List of signing steps |
AttachmentPlaceholder
PropertiesName | Type | Required | Description |
---|---|---|---|
RecipientId | string | ❌ | ID of the recipient |
Id | string | ❌ | ID of the attachment placeholder |
Name | string | ❌ | Name of the attachment placeholder |
Hint | string | ❌ | Hint of the attachment placeholder |
Required | bool | ❌ | Whether the attachment placeholder is required |
Multiple | bool | ❌ | Whether the attachment placeholder can have multiple files |
Files | []signplus.AttachmentPlaceholderFile | ❌ |
CreateEnvelopeRequest
PropertiesName | 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) PropertiesName | Type | Required | Description |
---|---|---|---|
SIGNER | string | ✅ | “SIGNER” |
RECEIVES_COPY | string | ✅ | “RECEIVES_COPY” |
IN_PERSON_SIGNER | string | ✅ | “IN_PERSON_SIGNER” |
SENDER | string | ✅ | “SENDER” |
ListWebhooksRequest
PropertiesName | 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) PropertiesName | 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
PropertiesName | Type | Required | Description |
---|---|---|---|
Annotations | []signplus.Annotation | ❌ |
AnnotationFontFamily
Font family of the text PropertiesName | Type | Required | Description |
---|---|---|---|
UNKNOWN | string | ✅ | “UNKNOWN” |
SERIF | string | ✅ | “SERIF” |
SANS | string | ✅ | “SANS” |
MONO | string | ✅ | “MONO” |
CreateTemplateRequest
PropertiesName | Type | Required | Description |
---|---|---|---|
Name | string | ✅ |
AddTemplateDocumentRequest
PropertiesName | Type | Required | Description |
---|---|---|---|
File | []byte | ✅ | File to upload in binary format |
SetEnvelopeExpirationRequest
PropertiesName | Type | Required | Description |
---|---|---|---|
ExpiresAt | int64 | ✅ | Unix timestamp of the expiration date |
SetEnvelopeLegalityLevelRequest
PropertiesName | 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
PropertiesName | Type | Required | Description |
---|---|---|---|
HasNextPage | bool | ❌ | Whether there is a next page |
HasPreviousPage | bool | ❌ | Whether there is a previous page |
Templates | []signplus.Template | ❌ |
SetTemplateCommentRequest
PropertiesName | Type | Required | Description |
---|---|---|---|
Comment | string | ✅ | Comment for the template |
ListEnvelopesResponse
PropertiesName | Type | Required | Description |
---|---|---|---|
HasNextPage | bool | ❌ | Whether there is a next page |
HasPreviousPage | bool | ❌ | Whether there is a previous page |
Envelopes | []signplus.Envelope | ❌ |
ListTemplatesRequest
PropertiesName | 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
PropertiesName | 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 PropertiesName | Type | Required | Description |
---|---|---|---|
TEXT | string | ✅ | “TEXT” |
SIGNATURE | string | ✅ | “SIGNATURE” |
INITIALS | string | ✅ | “INITIALS” |
CHECKBOX | string | ✅ | “CHECKBOX” |
DATE | string | ✅ | “DATE” |
ListWebhooksResponse
PropertiesName | Type | Required | Description |
---|---|---|---|
Webhooks | []signplus.Webhook | ❌ |
Webhook
PropertiesName | 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
PropertiesName | 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) PropertiesName | 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) PropertiesName | Type | Required | Description |
---|---|---|---|
SES | string | ✅ | “SES” |
QES_EIDAS | string | ✅ | “QES_EIDAS” |
QES_ZERTES | string | ✅ | “QES_ZERTES” |
ListTemplateDocumentsResponse
PropertiesName | Type | Required | Description |
---|---|---|---|
Documents | []signplus.Document | ❌ |
TemplateRecipient
PropertiesName | 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 |
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
PropertiesName | Type | Required | Description |
---|---|---|---|
Type_ | signplus.RecipientVerificationType | ❌ | Type of verification the recipient must complete before accessing the envelope. - PASSCODE : requires a code to be entered. - SMS : sends a code via SMS. - ID_VERIFICATION : prompts the recipient to complete an automated ID and selfie check. |
Value | string | ❌ | Required for PASSCODE and SMS verification. - PASSCODE : code required by the recipient to sign the document. - SMS : recipient’s phone number. - ID_VERIFICATION : leave empty. |
ListTemplateAnnotationsResponse
PropertiesName | Type | Required | Description |
---|---|---|---|
Annotations | []signplus.Annotation | ❌ |
SetEnvelopeAttachmentsPlaceholdersRequest
PropertiesName | Type | Required | Description |
---|---|---|---|
Placeholders | []signplus.AttachmentPlaceholderRequest | ✅ |
AttachmentPlaceholderRequest
PropertiesName | Type | Required | Description |
---|---|---|---|
RecipientId | string | ✅ | ID of the recipient |
Name | string | ✅ | |
Required | bool | ✅ | Whether the attachment placeholder is required |
Multiple | bool | ✅ | |
Id | string | ❌ | ID of the attachment placeholder |
Hint | string | ❌ | Hint of the attachment placeholder |
Annotation
PropertiesName | 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
PropertiesName | Type | Required | Description |
---|---|---|---|
Documents | []signplus.Document | ❌ |
CreateWebhookRequest
PropertiesName | Type | Required | Description |
---|---|---|---|
Event | signplus.WebhookEvent | ✅ | Event of the webhook |
Target | string | ✅ | URL of the webhook target |
Page
PropertiesName | Type | Required | Description |
---|---|---|---|
Width | int64 | ❌ | Width of the page in pixels |
Height | int64 | ❌ | Height of the page in pixels |
Recipient
PropertiesName | Type | Required | Description |
---|---|---|---|
Name | string | ✅ | Name of the recipient |
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 PropertiesName | 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” |
AttachmentPlaceholdersPerRecipient
PropertiesName | Type | Required | Description |
---|---|---|---|
RecipientId | string | ❌ | ID of the recipient |
RecipientName | string | ❌ | Name of the recipient |
Placeholders | []signplus.AttachmentPlaceholder | ❌ |
EnvelopeAttachments
PropertiesName | Type | Required | Description |
---|---|---|---|
Settings | signplus.AttachmentSettings | ❌ | |
Recipients | []signplus.AttachmentPlaceholdersPerRecipient | ❌ |
SigningStep
PropertiesName | Type | Required | Description |
---|---|---|---|
Recipients | []signplus.Recipient | ❌ | List of recipients |
EnvelopeStatus
Status of the envelope PropertiesName | 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
PropertiesName | 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 verification the recipient must complete before accessing the envelope. -PASSCODE
: requires a code to be entered. - SMS
: sends a code via SMS. - ID_VERIFICATION
: prompts the recipient to complete an automated ID and selfie check.
Properties
Name | Type | Required | Description |
---|---|---|---|
SMS | string | ✅ | “SMS” |
PASSCODE | string | ✅ | “PASSCODE” |
ID_VERIFICATION | string | ✅ | “ID_VERIFICATION” |
TemplateOrderField
Field to order templates by PropertiesName | 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) PropertiesName | 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) PropertiesName | Type | Required | Description |
---|---|---|---|
Id | string | ❌ | Unique identifier of the annotation signature |
AddAnnotationRequest
PropertiesName | 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) |
AttachmentSettings
PropertiesName | Type | Required | Description |
---|---|---|---|
VisibleToRecipients | bool | ❌ | Whether the attachment is visible to the recipients |
AnnotationDateTime
Date annotation (null if annotation is not a date) PropertiesName | 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
PropertiesName | Type | Required | Description |
---|---|---|---|
File | []byte | ❌ | File to upload in binary format |
EnvelopeNotification
PropertiesName | Type | Required | Description |
---|---|---|---|
Subject | string | ❌ | Subject of the notification |
Message | string | ❌ | Message of the notification |
ReminderInterval | int64 | ❌ | Interval in days to send reminder |