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

Methods	Description
create_envelope	Create new envelope
create_envelope_from_template	Create new envelope from template
list_envelopes	List envelopes
get_envelope	Get envelope
delete_envelope	Delete envelope
download_envelope_signed_documents	Download signed documents for an envelope
download_envelope_certificate	Download certificate of completion for an envelope
get_envelope_document	Get envelope document
get_envelope_documents	Get envelope documents
add_envelope_document	Add envelope document
set_envelope_dynamic_fields	Set envelope dynamic fields
add_envelope_signing_steps	Add envelope signing steps
set_envelope_attachments_settings	Set envelope attachment settings
set_envelope_attachments_placeholders	Placeholders to be set, completely replacing the existing ones.
get_attachment_file	Get envelope attachment file
send_envelope	Send envelope for signature
duplicate_envelope	Duplicate envelope
void_envelope	Void envelope
rename_envelope	Rename envelope
set_envelope_comment	Set envelope comment
set_envelope_notification	Set envelope notification
set_envelope_expiration_date	Set envelope expiration date
set_envelope_legality_level	Set envelope legality level
get_envelope_annotations	Get envelope annotations
get_envelope_document_annotations	Get envelope document annotations
add_envelope_annotation	Add envelope annotation
delete_envelope_annotation	Delete envelope annotation
create_template	Create new template
list_templates	List templates
get_template	Get template
delete_template	Delete template
duplicate_template	Duplicate template
add_template_document	Add template document
get_template_document	Get template document
get_template_documents	Get template documents
add_template_signing_steps	Add template signing steps
rename_template	Rename template
set_template_comment	Set template comment
set_template_notification	Set template notification
get_template_annotations	Get template annotations
get_document_template_annotations	Get document template annotations
add_template_annotation	Add template annotation
delete_template_annotation	Delete template annotation
set_template_attachments_settings	Set template attachment settings
set_template_attachments_placeholders	Placeholders to be set, completely replacing the existing ones.
create_webhook	Create webhook
list_webhooks	List webhooks
delete_webhook	Delete webhook

create_envelope

Create new envelope

HTTP Method: POST
Endpoint: /envelope

Parameters

Name	Type	Required	Description
request_body	CreateEnvelopeRequest	✅	The request body.

Return Type Envelope Example Usage Code Snippet

from signplus import Signplus
from signplus.models import CreateEnvelopeRequest

sdk = Signplus(
    access_token="YOUR_ACCESS_TOKEN",
    timeout=10000
)

request_body = CreateEnvelopeRequest(
    name="name",
    legality_level="SES",
    expires_at=8,
    comment="comment",
    sandbox=False
)

result = sdk.signplus.create_envelope(request_body=request_body)

print(result)

create_envelope_from_template

Create new envelope from template

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

Parameters

Name	Type	Required	Description
request_body	CreateEnvelopeFromTemplateRequest	✅	The request body.
template_id	str	✅

Return Type Envelope Example Usage Code Snippet

from signplus import Signplus
from signplus.models import CreateEnvelopeFromTemplateRequest

sdk = Signplus(
    access_token="YOUR_ACCESS_TOKEN",
    timeout=10000
)

request_body = CreateEnvelopeFromTemplateRequest(
    name="name",
    comment="comment",
    sandbox=True
)

result = sdk.signplus.create_envelope_from_template(
    request_body=request_body,
    template_id="template_id"
)

print(result)

list_envelopes

List envelopes

HTTP Method: POST
Endpoint: /envelopes

Parameters

Name	Type	Required	Description
request_body	ListEnvelopesRequest	❌	The request body.

Return Type ListEnvelopesResponse Example Usage Code Snippet

from signplus import Signplus
from signplus.models import ListEnvelopesRequest

sdk = Signplus(
    access_token="YOUR_ACCESS_TOKEN",
    timeout=10000
)

request_body = ListEnvelopesRequest(
    name="name",
    tags=[
        "tags"
    ],
    comment="comment",
    ids=[
        "ids"
    ],
    statuses=[
        "DRAFT"
    ],
    folder_ids=[
        "folder_ids"
    ],
    only_root_folder=True,
    date_from=5,
    date_to=9,
    uid="uid",
    first=9,
    last=7,
    after="after",
    before="before",
    order_field="CREATION_DATE",
    ascending=True,
    include_trash=True
)

result = sdk.signplus.list_envelopes(request_body=request_body)

print(result)

get_envelope

Get envelope

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

Parameters

Name	Type	Required	Description
envelope_id	str	✅

Return Type Envelope Example Usage Code Snippet

from signplus import Signplus

sdk = Signplus(
    access_token="YOUR_ACCESS_TOKEN",
    timeout=10000
)

result = sdk.signplus.get_envelope(envelope_id="envelope_id")

print(result)

delete_envelope

Delete envelope

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

Parameters

Name	Type	Required	Description
envelope_id	str	✅

Example Usage Code Snippet

from signplus import Signplus

sdk = Signplus(
    access_token="YOUR_ACCESS_TOKEN",
    timeout=10000
)

result = sdk.signplus.delete_envelope(envelope_id="envelope_id")

print(result)

download_envelope_signed_documents

Download signed documents for an envelope

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

Parameters

Name	Type	Required	Description
envelope_id	str	✅	ID of the envelope
certificate_of_completion	bool	❌	Whether to include the certificate of completion in the downloaded file

Return Type any Example Usage Code Snippet

from signplus import Signplus

sdk = Signplus(
    access_token="YOUR_ACCESS_TOKEN",
    timeout=10000
)

result = sdk.signplus.download_envelope_signed_documents(
    envelope_id="envelope_id",
    certificate_of_completion=True
)

print(result)

download_envelope_certificate

Download certificate of completion for an envelope

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

Parameters

Name	Type	Required	Description
envelope_id	str	✅	ID of the envelope

Return Type any Example Usage Code Snippet

from signplus import Signplus

sdk = Signplus(
    access_token="YOUR_ACCESS_TOKEN",
    timeout=10000
)

result = sdk.signplus.download_envelope_certificate(envelope_id="envelope_id")

print(result)

get_envelope_document

Get envelope document

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

Parameters

Name	Type	Required	Description
envelope_id	str	✅
document_id	str	✅

Return Type Document Example Usage Code Snippet

from signplus import Signplus

sdk = Signplus(
    access_token="YOUR_ACCESS_TOKEN",
    timeout=10000
)

result = sdk.signplus.get_envelope_document(
    envelope_id="envelope_id",
    document_id="document_id"
)

print(result)

get_envelope_documents

Get envelope documents

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

Parameters

Name	Type	Required	Description
envelope_id	str	✅

Return Type ListEnvelopeDocumentsResponse Example Usage Code Snippet

from signplus import Signplus

sdk = Signplus(
    access_token="YOUR_ACCESS_TOKEN",
    timeout=10000
)

result = sdk.signplus.get_envelope_documents(envelope_id="envelope_id")

print(result)

add_envelope_document

Add envelope document

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

Parameters

Name	Type	Required	Description
request_body	AddEnvelopeDocumentRequest	✅	The request body.
envelope_id	str	✅

Return Type Document Example Usage Code Snippet

from signplus import Signplus
from signplus.models import AddEnvelopeDocumentRequest

sdk = Signplus(
    access_token="YOUR_ACCESS_TOKEN",
    timeout=10000
)

request_body = AddEnvelopeDocumentRequest(
    file="file"
)

result = sdk.signplus.add_envelope_document(
    request_body=request_body,
    envelope_id="envelope_id"
)

print(result)

set_envelope_dynamic_fields

Set envelope dynamic fields

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

Parameters

Name	Type	Required	Description
request_body	SetEnvelopeDynamicFieldsRequest	✅	The request body.
envelope_id	str	✅

Return Type Envelope Example Usage Code Snippet

from signplus import Signplus
from signplus.models import SetEnvelopeDynamicFieldsRequest

sdk = Signplus(
    access_token="YOUR_ACCESS_TOKEN",
    timeout=10000
)

request_body = SetEnvelopeDynamicFieldsRequest(
    dynamic_fields=[
        {
            "name": "name",
            "value": "value"
        }
    ]
)

result = sdk.signplus.set_envelope_dynamic_fields(
    request_body=request_body,
    envelope_id="envelope_id"
)

print(result)

add_envelope_signing_steps

Add envelope signing steps

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

Parameters

Name	Type	Required	Description
request_body	AddEnvelopeSigningStepsRequest	✅	The request body.
envelope_id	str	✅

Return Type Envelope Example Usage Code Snippet

from signplus import Signplus
from signplus.models import AddEnvelopeSigningStepsRequest

sdk = Signplus(
    access_token="YOUR_ACCESS_TOKEN",
    timeout=10000
)

request_body = AddEnvelopeSigningStepsRequest(
    signing_steps=[
        {
            "recipients": [
                {
                    "id_": "id",
                    "uid": "uid",
                    "name": "name",
                    "email": "email",
                    "role": "SIGNER",
                    "verification": {
                        "type_": "SMS",
                        "value": "value"
                    }
                }
            ]
        }
    ]
)

result = sdk.signplus.add_envelope_signing_steps(
    request_body=request_body,
    envelope_id="envelope_id"
)

print(result)

set_envelope_attachments_settings

Set envelope attachment settings

HTTP Method: PUT
Endpoint: /envelope/{envelope_id}/attachments/settings

Parameters

Name	Type	Required	Description
request_body	SetEnvelopeAttachmentsSettingsRequest	✅	The request body.
envelope_id	str	✅

Return Type EnvelopeAttachments Example Usage Code Snippet

from signplus import Signplus
from signplus.models import SetEnvelopeAttachmentsSettingsRequest

sdk = Signplus(
    access_token="YOUR_ACCESS_TOKEN",
    timeout=10000
)

request_body = SetEnvelopeAttachmentsSettingsRequest(
    settings={
        "visible_to_recipients": False
    }
)

result = sdk.signplus.set_envelope_attachments_settings(
    request_body=request_body,
    envelope_id="envelope_id"
)

print(result)

set_envelope_attachments_placeholders

Placeholders to be set, completely replacing the existing ones.

HTTP Method: PUT
Endpoint: /envelope/{envelope_id}/attachments/placeholders

Parameters

Name	Type	Required	Description
request_body	SetEnvelopeAttachmentsPlaceholdersRequest	✅	The request body.
envelope_id	str	✅

Return Type EnvelopeAttachments Example Usage Code Snippet

from signplus import Signplus
from signplus.models import SetEnvelopeAttachmentsPlaceholdersRequest

sdk = Signplus(
    access_token="YOUR_ACCESS_TOKEN",
    timeout=10000
)

request_body = SetEnvelopeAttachmentsPlaceholdersRequest(
    placeholders=[
        {
            "recipient_id": "recipient_id",
            "id_": "id",
            "name": "name",
            "hint": "hint",
            "required": False,
            "multiple": True
        }
    ]
)

result = sdk.signplus.set_envelope_attachments_placeholders(
    request_body=request_body,
    envelope_id="envelope_id"
)

print(result)

get_attachment_file

Get envelope attachment file

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

Parameters

Name	Type	Required	Description
envelope_id	str	✅
file_id	str	✅

Return Type bytes Example Usage Code Snippet

from signplus import Signplus

sdk = Signplus(
    access_token="YOUR_ACCESS_TOKEN",
    timeout=10000
)

result = sdk.signplus.get_attachment_file(
    envelope_id="envelope_id",
    file_id="file_id"
)

with open("output-file.ext", "wb") as f:
    f.write(result)

send_envelope

Send envelope for signature

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

Parameters

Name	Type	Required	Description
envelope_id	str	✅

Return Type Envelope Example Usage Code Snippet

from signplus import Signplus

sdk = Signplus(
    access_token="YOUR_ACCESS_TOKEN",
    timeout=10000
)

result = sdk.signplus.send_envelope(envelope_id="envelope_id")

print(result)

duplicate_envelope

Duplicate envelope

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

Parameters

Name	Type	Required	Description
envelope_id	str	✅

Return Type Envelope Example Usage Code Snippet

from signplus import Signplus

sdk = Signplus(
    access_token="YOUR_ACCESS_TOKEN",
    timeout=10000
)

result = sdk.signplus.duplicate_envelope(envelope_id="envelope_id")

print(result)

void_envelope

Void envelope

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

Parameters

Name	Type	Required	Description
envelope_id	str	✅

Return Type Envelope Example Usage Code Snippet

from signplus import Signplus

sdk = Signplus(
    access_token="YOUR_ACCESS_TOKEN",
    timeout=10000
)

result = sdk.signplus.void_envelope(envelope_id="envelope_id")

print(result)

rename_envelope

Rename envelope

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

Parameters

Name	Type	Required	Description
request_body	RenameEnvelopeRequest	✅	The request body.
envelope_id	str	✅

Return Type Envelope Example Usage Code Snippet

from signplus import Signplus
from signplus.models import RenameEnvelopeRequest

sdk = Signplus(
    access_token="YOUR_ACCESS_TOKEN",
    timeout=10000
)

request_body = RenameEnvelopeRequest(
    name="name"
)

result = sdk.signplus.rename_envelope(
    request_body=request_body,
    envelope_id="envelope_id"
)

print(result)

set_envelope_comment

Set envelope comment

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

Parameters

Name	Type	Required	Description
request_body	SetEnvelopeCommentRequest	✅	The request body.
envelope_id	str	✅

Return Type Envelope Example Usage Code Snippet

from signplus import Signplus
from signplus.models import SetEnvelopeCommentRequest

sdk = Signplus(
    access_token="YOUR_ACCESS_TOKEN",
    timeout=10000
)

request_body = SetEnvelopeCommentRequest(
    comment="comment"
)

result = sdk.signplus.set_envelope_comment(
    request_body=request_body,
    envelope_id="envelope_id"
)

print(result)

set_envelope_notification

Set envelope notification

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

Parameters

Name	Type	Required	Description
request_body	EnvelopeNotification	✅	The request body.
envelope_id	str	✅

Return Type Envelope Example Usage Code Snippet

from signplus import Signplus
from signplus.models import EnvelopeNotification

sdk = Signplus(
    access_token="YOUR_ACCESS_TOKEN",
    timeout=10000
)

request_body = EnvelopeNotification(
    subject="subject",
    message="message",
    reminder_interval=1
)

result = sdk.signplus.set_envelope_notification(
    request_body=request_body,
    envelope_id="envelope_id"
)

print(result)

set_envelope_expiration_date

Set envelope expiration date

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

Parameters

Name	Type	Required	Description
request_body	SetEnvelopeExpirationRequest	✅	The request body.
envelope_id	str	✅

Return Type Envelope Example Usage Code Snippet

from signplus import Signplus
from signplus.models import SetEnvelopeExpirationRequest

sdk = Signplus(
    access_token="YOUR_ACCESS_TOKEN",
    timeout=10000
)

request_body = SetEnvelopeExpirationRequest(
    expires_at=0
)

result = sdk.signplus.set_envelope_expiration_date(
    request_body=request_body,
    envelope_id="envelope_id"
)

print(result)

set_envelope_legality_level

Set envelope legality level

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

Parameters

Name	Type	Required	Description
request_body	SetEnvelopeLegalityLevelRequest	✅	The request body.
envelope_id	str	✅

Return Type Envelope Example Usage Code Snippet

from signplus import Signplus
from signplus.models import SetEnvelopeLegalityLevelRequest

sdk = Signplus(
    access_token="YOUR_ACCESS_TOKEN",
    timeout=10000
)

request_body = SetEnvelopeLegalityLevelRequest(
    legality_level="SES"
)

result = sdk.signplus.set_envelope_legality_level(
    request_body=request_body,
    envelope_id="envelope_id"
)

print(result)

get_envelope_annotations

Get envelope annotations

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

Parameters

Name	Type	Required	Description
envelope_id	str	✅	ID of the envelope

Return Type List[Annotation] Example Usage Code Snippet

from signplus import Signplus

sdk = Signplus(
    access_token="YOUR_ACCESS_TOKEN",
    timeout=10000
)

result = sdk.signplus.get_envelope_annotations(envelope_id="envelope_id")

print(result)

get_envelope_document_annotations

Get envelope document annotations

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

Parameters

Name	Type	Required	Description
envelope_id	str	✅	ID of the envelope
document_id	str	✅	ID of document

Return Type ListEnvelopeDocumentAnnotationsResponse Example Usage Code Snippet

from signplus import Signplus

sdk = Signplus(
    access_token="YOUR_ACCESS_TOKEN",
    timeout=10000
)

result = sdk.signplus.get_envelope_document_annotations(
    envelope_id="envelope_id",
    document_id="document_id"
)

print(result)

add_envelope_annotation

Add envelope annotation

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

Parameters

Name	Type	Required	Description
request_body	AddAnnotationRequest	✅	The request body.
envelope_id	str	✅	ID of the envelope

Return Type Annotation Example Usage Code Snippet

from signplus import Signplus
from signplus.models import AddAnnotationRequest

sdk = Signplus(
    access_token="YOUR_ACCESS_TOKEN",
    timeout=10000
)

request_body = AddAnnotationRequest(
    recipient_id="recipient_id",
    document_id="document_id",
    page=2,
    x=1.99,
    y=8.2,
    width=4.89,
    height=9.43,
    required=False,
    type_="TEXT",
    signature={
        "id_": "id"
    },
    initials={
        "id_": "id"
    },
    text={
        "size": 5.96,
        "color": 8.73,
        "value": "value",
        "tooltip": "tooltip",
        "dynamic_field_name": "dynamic_field_name",
        "font": {
            "family": "UNKNOWN",
            "italic": True,
            "bold": True
        }
    },
    datetime_={
        "size": 0.26,
        "font": {
            "family": "UNKNOWN",
            "italic": True,
            "bold": True
        },
        "color": "color",
        "auto_fill": True,
        "timezone": "timezone",
        "timestamp": 1,
        "format": "DMY_NUMERIC_SLASH"
    },
    checkbox={
        "checked": True,
        "style": "CIRCLE_CHECK"
    }
)

result = sdk.signplus.add_envelope_annotation(
    request_body=request_body,
    envelope_id="envelope_id"
)

print(result)

delete_envelope_annotation

Delete envelope annotation

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

Parameters

Name	Type	Required	Description
envelope_id	str	✅	ID of the envelope
annotation_id	str	✅	ID of the annotation to delete

Example Usage Code Snippet

from signplus import Signplus

sdk = Signplus(
    access_token="YOUR_ACCESS_TOKEN",
    timeout=10000
)

result = sdk.signplus.delete_envelope_annotation(
    envelope_id="envelope_id",
    annotation_id="annotation_id"
)

print(result)

create_template

Create new template

HTTP Method: POST
Endpoint: /template

Parameters

Name	Type	Required	Description
request_body	CreateTemplateRequest	✅	The request body.

Return Type Template Example Usage Code Snippet

from signplus import Signplus
from signplus.models import CreateTemplateRequest

sdk = Signplus(
    access_token="YOUR_ACCESS_TOKEN",
    timeout=10000
)

request_body = CreateTemplateRequest(
    name="name"
)

result = sdk.signplus.create_template(request_body=request_body)

print(result)

list_templates

List templates

HTTP Method: POST
Endpoint: /templates

Parameters

Name	Type	Required	Description
request_body	ListTemplatesRequest	❌	The request body.

Return Type ListTemplatesResponse Example Usage Code Snippet

from signplus import Signplus
from signplus.models import ListTemplatesRequest

sdk = Signplus(
    access_token="YOUR_ACCESS_TOKEN",
    timeout=10000
)

request_body = ListTemplatesRequest(
    name="name",
    tags=[
        "tags"
    ],
    ids=[
        "ids"
    ],
    first=1,
    last=6,
    after="after",
    before="before",
    order_field="TEMPLATE_ID",
    ascending=False
)

result = sdk.signplus.list_templates(request_body=request_body)

print(result)

get_template

Get template

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

Parameters

Name	Type	Required	Description
template_id	str	✅

Return Type Template Example Usage Code Snippet

from signplus import Signplus

sdk = Signplus(
    access_token="YOUR_ACCESS_TOKEN",
    timeout=10000
)

result = sdk.signplus.get_template(template_id="template_id")

print(result)

delete_template

Delete template

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

Parameters

Name	Type	Required	Description
template_id	str	✅

Example Usage Code Snippet

from signplus import Signplus

sdk = Signplus(
    access_token="YOUR_ACCESS_TOKEN",
    timeout=10000
)

result = sdk.signplus.delete_template(template_id="template_id")

print(result)

duplicate_template

Duplicate template

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

Parameters

Name	Type	Required	Description
template_id	str	✅

Return Type Template Example Usage Code Snippet

from signplus import Signplus

sdk = Signplus(
    access_token="YOUR_ACCESS_TOKEN",
    timeout=10000
)

result = sdk.signplus.duplicate_template(template_id="template_id")

print(result)

add_template_document

Add template document

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

Parameters

Name	Type	Required	Description
request_body	AddTemplateDocumentRequest	✅	The request body.
template_id	str	✅

Return Type Document Example Usage Code Snippet

from signplus import Signplus
from signplus.models import AddTemplateDocumentRequest

sdk = Signplus(
    access_token="YOUR_ACCESS_TOKEN",
    timeout=10000
)

request_body = AddTemplateDocumentRequest(
    file="file"
)

result = sdk.signplus.add_template_document(
    request_body=request_body,
    template_id="template_id"
)

print(result)

get_template_document

Get template document

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

Parameters

Name	Type	Required	Description
template_id	str	✅
document_id	str	✅

Return Type Document Example Usage Code Snippet

from signplus import Signplus

sdk = Signplus(
    access_token="YOUR_ACCESS_TOKEN",
    timeout=10000
)

result = sdk.signplus.get_template_document(
    template_id="template_id",
    document_id="document_id"
)

print(result)

get_template_documents

Get template documents

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

Parameters

Name	Type	Required	Description
template_id	str	✅

Return Type ListTemplateDocumentsResponse Example Usage Code Snippet

from signplus import Signplus

sdk = Signplus(
    access_token="YOUR_ACCESS_TOKEN",
    timeout=10000
)

result = sdk.signplus.get_template_documents(template_id="template_id")

print(result)

add_template_signing_steps

Add template signing steps

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

Parameters

Name	Type	Required	Description
request_body	AddTemplateSigningStepsRequest	✅	The request body.
template_id	str	✅

Return Type Template Example Usage Code Snippet

from signplus import Signplus
from signplus.models import AddTemplateSigningStepsRequest

sdk = Signplus(
    access_token="YOUR_ACCESS_TOKEN",
    timeout=10000
)

request_body = AddTemplateSigningStepsRequest(
    signing_steps=[
        {
            "recipients": [
                {
                    "id_": "id",
                    "uid": "uid",
                    "name": "name",
                    "email": "email",
                    "role": "SIGNER"
                }
            ]
        }
    ]
)

result = sdk.signplus.add_template_signing_steps(
    request_body=request_body,
    template_id="template_id"
)

print(result)

rename_template

Rename template

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

Parameters

Name	Type	Required	Description
request_body	RenameTemplateRequest	✅	The request body.
template_id	str	✅

Return Type Template Example Usage Code Snippet

from signplus import Signplus
from signplus.models import RenameTemplateRequest

sdk = Signplus(
    access_token="YOUR_ACCESS_TOKEN",
    timeout=10000
)

request_body = RenameTemplateRequest(
    name="name"
)

result = sdk.signplus.rename_template(
    request_body=request_body,
    template_id="template_id"
)

print(result)

set_template_comment

Set template comment

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

Parameters

Name	Type	Required	Description
request_body	SetTemplateCommentRequest	✅	The request body.
template_id	str	✅

Return Type Template Example Usage Code Snippet

from signplus import Signplus
from signplus.models import SetTemplateCommentRequest

sdk = Signplus(
    access_token="YOUR_ACCESS_TOKEN",
    timeout=10000
)

request_body = SetTemplateCommentRequest(
    comment="comment"
)

result = sdk.signplus.set_template_comment(
    request_body=request_body,
    template_id="template_id"
)

print(result)

set_template_notification

Set template notification

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

Parameters

Name	Type	Required	Description
request_body	EnvelopeNotification	✅	The request body.
template_id	str	✅

Return Type Template Example Usage Code Snippet

from signplus import Signplus
from signplus.models import EnvelopeNotification

sdk = Signplus(
    access_token="YOUR_ACCESS_TOKEN",
    timeout=10000
)

request_body = EnvelopeNotification(
    subject="subject",
    message="message",
    reminder_interval=1
)

result = sdk.signplus.set_template_notification(
    request_body=request_body,
    template_id="template_id"
)

print(result)

get_template_annotations

Get template annotations

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

Parameters

Name	Type	Required	Description
template_id	str	✅	ID of the template

Return Type ListTemplateAnnotationsResponse Example Usage Code Snippet

from signplus import Signplus

sdk = Signplus(
    access_token="YOUR_ACCESS_TOKEN",
    timeout=10000
)

result = sdk.signplus.get_template_annotations(template_id="template_id")

print(result)

get_document_template_annotations

Get document template annotations

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

Parameters

Name	Type	Required	Description
template_id	str	✅	ID of the template
document_id	str	✅	ID of document

Return Type ListTemplateDocumentAnnotationsResponse Example Usage Code Snippet

from signplus import Signplus

sdk = Signplus(
    access_token="YOUR_ACCESS_TOKEN",
    timeout=10000
)

result = sdk.signplus.get_document_template_annotations(
    template_id="template_id",
    document_id="document_id"
)

print(result)

add_template_annotation

Add template annotation

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

Parameters

Name	Type	Required	Description
request_body	AddAnnotationRequest	✅	The request body.
template_id	str	✅	ID of the template

Return Type Annotation Example Usage Code Snippet

from signplus import Signplus
from signplus.models import AddAnnotationRequest

sdk = Signplus(
    access_token="YOUR_ACCESS_TOKEN",
    timeout=10000
)

request_body = AddAnnotationRequest(
    recipient_id="recipient_id",
    document_id="document_id",
    page=2,
    x=1.99,
    y=8.2,
    width=4.89,
    height=9.43,
    required=False,
    type_="TEXT",
    signature={
        "id_": "id"
    },
    initials={
        "id_": "id"
    },
    text={
        "size": 5.96,
        "color": 8.73,
        "value": "value",
        "tooltip": "tooltip",
        "dynamic_field_name": "dynamic_field_name",
        "font": {
            "family": "UNKNOWN",
            "italic": True,
            "bold": True
        }
    },
    datetime_={
        "size": 0.26,
        "font": {
            "family": "UNKNOWN",
            "italic": True,
            "bold": True
        },
        "color": "color",
        "auto_fill": True,
        "timezone": "timezone",
        "timestamp": 1,
        "format": "DMY_NUMERIC_SLASH"
    },
    checkbox={
        "checked": True,
        "style": "CIRCLE_CHECK"
    }
)

result = sdk.signplus.add_template_annotation(
    request_body=request_body,
    template_id="template_id"
)

print(result)

delete_template_annotation

Delete template annotation

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

Parameters

Name	Type	Required	Description
template_id	str	✅	ID of the template
annotation_id	str	✅	ID of the annotation to delete

Example Usage Code Snippet

from signplus import Signplus

sdk = Signplus(
    access_token="YOUR_ACCESS_TOKEN",
    timeout=10000
)

result = sdk.signplus.delete_template_annotation(
    template_id="template_id",
    annotation_id="annotation_id"
)

print(result)

set_template_attachments_settings

Set template attachment settings

HTTP Method: PUT
Endpoint: /template/{template_id}/attachments/settings

Parameters

Name	Type	Required	Description
request_body	SetEnvelopeAttachmentsSettingsRequest	✅	The request body.
template_id	str	✅

Return Type EnvelopeAttachments Example Usage Code Snippet

from signplus import Signplus
from signplus.models import SetEnvelopeAttachmentsSettingsRequest

sdk = Signplus(
    access_token="YOUR_ACCESS_TOKEN",
    timeout=10000
)

request_body = SetEnvelopeAttachmentsSettingsRequest(
    settings={
        "visible_to_recipients": False
    }
)

result = sdk.signplus.set_template_attachments_settings(
    request_body=request_body,
    template_id="template_id"
)

print(result)

set_template_attachments_placeholders

Placeholders to be set, completely replacing the existing ones.

HTTP Method: PUT
Endpoint: /template/{template_id}/attachments/placeholders

Parameters

Name	Type	Required	Description
request_body	SetEnvelopeAttachmentsPlaceholdersRequest	✅	The request body.
template_id	str	✅

Return Type EnvelopeAttachments Example Usage Code Snippet

from signplus import Signplus
from signplus.models import SetEnvelopeAttachmentsPlaceholdersRequest

sdk = Signplus(
    access_token="YOUR_ACCESS_TOKEN",
    timeout=10000
)

request_body = SetEnvelopeAttachmentsPlaceholdersRequest(
    placeholders=[
        {
            "recipient_id": "recipient_id",
            "id_": "id",
            "name": "name",
            "hint": "hint",
            "required": False,
            "multiple": True
        }
    ]
)

result = sdk.signplus.set_template_attachments_placeholders(
    request_body=request_body,
    template_id="template_id"
)

print(result)

create_webhook

Create webhook

HTTP Method: POST
Endpoint: /webhook

Parameters

Name	Type	Required	Description
request_body	CreateWebhookRequest	✅	The request body.

Return Type Webhook Example Usage Code Snippet

from signplus import Signplus
from signplus.models import CreateWebhookRequest

sdk = Signplus(
    access_token="YOUR_ACCESS_TOKEN",
    timeout=10000
)

request_body = CreateWebhookRequest(
    event="ENVELOPE_EXPIRED",
    target="target"
)

result = sdk.signplus.create_webhook(request_body=request_body)

print(result)

list_webhooks

List webhooks

HTTP Method: POST
Endpoint: /webhooks

Parameters

Name	Type	Required	Description
request_body	ListWebhooksRequest	❌	The request body.

Return Type ListWebhooksResponse Example Usage Code Snippet

from signplus import Signplus
from signplus.models import ListWebhooksRequest

sdk = Signplus(
    access_token="YOUR_ACCESS_TOKEN",
    timeout=10000
)

request_body = ListWebhooksRequest(
    webhook_id="webhook_id",
    event="ENVELOPE_EXPIRED"
)

result = sdk.signplus.list_webhooks(request_body=request_body)

print(result)

delete_webhook

Delete webhook

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

Parameters

Name	Type	Required	Description
webhook_id	str	✅

Example Usage Code Snippet

from signplus import Signplus

sdk = Signplus(
    access_token="YOUR_ACCESS_TOKEN",
    timeout=10000
)

result = sdk.signplus.delete_webhook(webhook_id="webhook_id")

print(result)

Models

SetEnvelopeAttachmentsPlaceholdersRequest

Properties

Name	Type	Required	Description
placeholders	List[AttachmentPlaceholderRequest]	✅

Document

Properties

Name	Type	Required	Description
id_	str	❌	Unique identifier of the document
name	str	❌	Name of the document
filename	str	❌	Filename of the document
page_count	int	❌	Number of pages in the document
pages	List[Page]	❌	List of pages in the document

CreateEnvelopeRequest

Properties

Name	Type	Required	Description
name	str	✅	Name of the envelope
legality_level	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)
expires_at	int	❌	Unix timestamp of the expiration date
comment	str	❌	Comment for the envelope
sandbox	bool	❌	Whether the envelope is created in sandbox mode

ListEnvelopesRequest

Properties

Name	Type	Required	Description
name	str	❌	Name of the envelope
tags	List[str]	❌	List of tags
comment	str	❌	Comment of the envelope
ids	List[str]	❌	List of envelope IDs
statuses	List[EnvelopeStatus]	❌	List of envelope statuses
folder_ids	List[str]	❌	List of folder IDs
only_root_folder	bool	❌	Whether to only list envelopes in the root folder
date_from	int	❌	Unix timestamp of the start date
date_to	int	❌	Unix timestamp of the end date
uid	str	❌	Unique identifier of the user
first	int	❌
last	int	❌
after	str	❌
before	str	❌
order_field	EnvelopeOrderField	❌	Field to order envelopes by
ascending	bool	❌	Whether to order envelopes in ascending order
include_trash	bool	❌	Whether to include envelopes in the trash

AttachmentPlaceholder

Properties

Name	Type	Required	Description
recipient_id	str	❌	ID of the recipient
id_	str	❌	ID of the attachment placeholder
name	str	❌	Name of the attachment placeholder
hint	str	❌	Hint of the attachment placeholder
required	bool	❌	Whether the attachment placeholder is required
multiple	bool	❌	Whether the attachment placeholder can have multiple files
files	List[AttachmentPlaceholderFile]	❌

SetEnvelopeAttachmentsSettingsRequest

Properties

Name	Type	Required	Description
settings	AttachmentSettings	✅

EnvelopeNotification

Properties

Name	Type	Required	Description
subject	str	❌	Subject of the notification
message	str	❌	Message of the notification
reminder_interval	int	❌	Interval in days to send reminder

ListTemplatesRequest

Properties

Name	Type	Required	Description
name	str	❌	Name of the template
tags	List[str]	❌	List of tag templates
ids	List[str]	❌	List of templates IDs
first	int	❌
last	int	❌
after	str	❌
before	str	❌
order_field	TemplateOrderField	❌	Field to order templates by
ascending	bool	❌	Whether to order templates in ascending order

SetTemplateCommentRequest

Properties

Name	Type	Required	Description
comment	str	✅	Comment for the template

Template

Properties

Name	Type	Required	Description
id_	str	❌	Unique identifier of the template
name	str	❌	Name of the template
comment	str	❌	Comment for the template
pages	int	❌	Total number of pages in the template
legality_level	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)
created_at	int	❌	Unix timestamp of the creation date
updated_at	int	❌	Unix timestamp of the last modification date
expiration_delay	int	❌	Expiration delay added to the current time when an envelope is created from this template
num_recipients	int	❌	Number of recipients in the envelope
signing_steps	List[TemplateSigningStep]	❌
documents	List[Document]	❌
notification	EnvelopeNotification	❌
dynamic_fields	List[str]	❌	List of dynamic fields
attachments	EnvelopeAttachments	❌

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	str	✅	“SMS”
PASSCODE	str	✅	“PASSCODE”
IDVERIFICATION	str	✅	“ID_VERIFICATION”

AddEnvelopeSigningStepsRequest

Properties

Name	Type	Required	Description
signing_steps	List[SigningStep]	❌	List of signing steps

AnnotationFontFamily

Font family of the text Properties

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

AddTemplateSigningStepsRequest

Properties

Name	Type	Required	Description
signing_steps	List[TemplateSigningStep]	✅	List of signing steps

SetEnvelopeCommentRequest

Properties

Name	Type	Required	Description
comment	str	✅	Comment for the envelope

TemplateOrderField

Field to order templates by Properties

Name	Type	Required	Description
TEMPLATEID	str	✅	“TEMPLATE_ID”
TEMPLATECREATIONDATE	str	✅	“TEMPLATE_CREATION_DATE”
TEMPLATEMODIFICATIONDATE	str	✅	“TEMPLATE_MODIFICATION_DATE”
TEMPLATENAME	str	✅	“TEMPLATE_NAME”

EnvelopeOrderField

Field to order envelopes by Properties

Name	Type	Required	Description
CREATIONDATE	str	✅	“CREATION_DATE”
MODIFICATIONDATE	str	✅	“MODIFICATION_DATE”
NAME	str	✅	“NAME”
STATUS	str	✅	“STATUS”
LASTDOCUMENTCHANGE	str	✅	“LAST_DOCUMENT_CHANGE”

AddEnvelopeDocumentRequest

Properties

Name	Type	Required	Description
file	bytes	❌	File to upload in binary format

ListWebhooksRequest

Properties

Name	Type	Required	Description
webhook_id	str	❌	ID of the webhook
event	WebhookEvent	❌	Event of the webhook

SetEnvelopeLegalityLevelRequest

Properties

Name	Type	Required	Description
legality_level	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)

AttachmentPlaceholderFile

Properties

Name	Type	Required	Description
id_	str	❌	ID of the file
name	str	❌	Name of the file
size	int	❌	Size of the file in bytes
mimetype	str	❌	MIME type of the file

SetEnvelopeExpirationRequest

Properties

Name	Type	Required	Description
expires_at	int	✅	Unix timestamp of the expiration date

AnnotationText

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

Name	Type	Required	Description
size	float	❌	Font size of the text in pt
color	float	❌	Text color in 32bit representation
value	str	❌	Text content of the annotation
tooltip	str	❌	Tooltip of the annotation
dynamic_field_name	str	❌	Name of the dynamic field
font	AnnotationFont	❌

AnnotationCheckbox

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

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

Envelope

Properties

Name	Type	Required	Description
id_	str	❌	Unique identifier of the envelope
name	str	❌	Name of the envelope
comment	str	❌	Comment for the envelope
pages	int	❌	Total number of pages in the envelope
flow_type	EnvelopeFlowType	❌	Flow type of the envelope (REQUEST_SIGNATURE is a request for signature, SIGN_MYSELF is a self-signing flow)
legality_level	EnvelopeLegalityLevel	❌	Legal level of the envelope (SES is Simple Electronic Signature, QES_EIDAS is Qualified Electronic Signature, QES_ZERTES is Qualified Electronic Signature with Zertes)
status	EnvelopeStatus	❌	Status of the envelope
created_at	int	❌	Unix timestamp of the creation date
updated_at	int	❌	Unix timestamp of the last modification date
expires_at	int	❌	Unix timestamp of the expiration date
num_recipients	int	❌	Number of recipients in the envelope
is_duplicable	bool	❌	Whether the envelope can be duplicated
signing_steps	List[SigningStep]	❌
documents	List[Document]	❌
notification	EnvelopeNotification	❌
attachments	EnvelopeAttachments	❌

AddTemplateDocumentRequest

Properties

Name	Type	Required	Description
file	bytes	✅	File to upload in binary format

TemplateRecipient

Properties

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

AddAnnotationRequest

Properties

Name	Type	Required	Description
document_id	str	✅	ID of the document
page	int	✅	Page number where the annotation is placed
x	float	✅	X coordinate of the annotation (in % of the page width from 0 to 100) from the top left corner
y	float	✅	Y coordinate of the annotation (in % of the page height from 0 to 100) from the top left corner
width	float	✅	Width of the annotation (in % of the page width from 0 to 100)
height	float	✅	Height of the annotation (in % of the page height from 0 to 100)
type_	AnnotationType	✅	Type of the annotation
recipient_id	str	❌	ID of the recipient
required	bool	❌
signature	AnnotationSignature	❌	Signature annotation (null if annotation is not a signature)
initials	AnnotationInitials	❌	Initials annotation (null if annotation is not initials)
text	AnnotationText	❌	Text annotation (null if annotation is not a text)
datetime_	AnnotationDateTime	❌	Date annotation (null if annotation is not a date)
checkbox	AnnotationCheckbox	❌	Checkbox annotation (null if annotation is not a checkbox)

ListEnvelopeDocumentAnnotationsResponse

Properties

Name	Type	Required	Description
annotations	List[Annotation]	❌

EnvelopeStatus

Status of the envelope Properties

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

RecipientVerification

Properties

Name	Type	Required	Description
type_	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	str	❌	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.

AnnotationCheckboxStyle

Style of the checkbox Properties

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

SigningStep

Properties

Name	Type	Required	Description
recipients	List[Recipient]	❌	List of recipients

AnnotationDateTime

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

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

AttachmentSettings

Properties

Name	Type	Required	Description
visible_to_recipients	bool	❌	Whether the attachment is visible to the recipients

CreateTemplateRequest

Properties

Name	Type	Required	Description
name	str	✅

ListTemplateDocumentsResponse

Properties

Name	Type	Required	Description
documents	List[Document]	❌

AnnotationInitials

Initials annotation (null if annotation is not initials) Properties

Name	Type	Required	Description
id_	str	❌	Unique identifier of the annotation initials

AnnotationFont

Properties

Name	Type	Required	Description
family	AnnotationFontFamily	❌	Font family of the text
italic	bool	❌	Whether the text is italic
bold	bool	❌	Whether the text is bold

AnnotationType

Type of the annotation Properties

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

Webhook

Properties

Name	Type	Required	Description
id_	str	❌	Unique identifier of the webhook
event	WebhookEvent	❌	Event of the webhook
target	str	❌	Target URL of the webhook

RenameTemplateRequest

Properties

Name	Type	Required	Description
name	str	✅	Name of the template

ListTemplatesResponse

Properties

Name	Type	Required	Description
has_next_page	bool	❌	Whether there is a next page
has_previous_page	bool	❌	Whether there is a previous page
templates	List[Template]	❌

EnvelopeAttachments

Properties

Name	Type	Required	Description
settings	AttachmentSettings	❌
recipients	List[AttachmentPlaceholdersPerRecipient]	❌

RecipientRole

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

Name	Type	Required	Description
SIGNER	str	✅	“SIGNER”
RECEIVESCOPY	str	✅	“RECEIVES_COPY”
INPERSONSIGNER	str	✅	“IN_PERSON_SIGNER”

Annotation

Properties

Name	Type	Required	Description
id_	str	❌	Unique identifier of the annotation
recipient_id	str	❌	ID of the recipient
document_id	str	❌	ID of the document
page	int	❌	Page number where the annotation is placed
x	float	❌	X coordinate of the annotation (in % of the page width from 0 to 100) from the top left corner
y	float	❌	Y coordinate of the annotation (in % of the page height from 0 to 100) from the top left corner
width	float	❌	Width of the annotation (in % of the page width from 0 to 100)
height	float	❌	Height of the annotation (in % of the page height from 0 to 100)
required	bool	❌	Whether the annotation is required
type_	AnnotationType	❌	Type of the annotation
signature	AnnotationSignature	❌	Signature annotation (null if annotation is not a signature)
initials	AnnotationInitials	❌	Initials annotation (null if annotation is not initials)
text	AnnotationText	❌	Text annotation (null if annotation is not a text)
datetime_	AnnotationDateTime	❌	Date annotation (null if annotation is not a date)
checkbox	AnnotationCheckbox	❌	Checkbox annotation (null if annotation is not a checkbox)

DynamicField

Properties

Name	Type	Required	Description
name	str	❌	Name of the dynamic field
value	str	❌	Value of the dynamic field

AnnotationDateTimeFormat

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

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

EnvelopeFlowType

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

Name	Type	Required	Description
REQUESTSIGNATURE	str	✅	“REQUEST_SIGNATURE”
SIGNMYSELF	str	✅	“SIGN_MYSELF”

EnvelopeLegalityLevel

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

Name	Type	Required	Description
SES	str	✅	“SES”
QESEIDAS	str	✅	“QES_EIDAS”
QESZERTES	str	✅	“QES_ZERTES”

TemplateRecipientRole

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

Name	Type	Required	Description
SIGNER	str	✅	“SIGNER”
RECEIVESCOPY	str	✅	“RECEIVES_COPY”
INPERSONSIGNER	str	✅	“IN_PERSON_SIGNER”
SENDER	str	✅	“SENDER”

AttachmentPlaceholderRequest

Properties

Name	Type	Required	Description
recipient_id	str	✅	ID of the recipient
name	str	✅
required	bool	✅	Whether the attachment placeholder is required
multiple	bool	✅
id_	str	❌	ID of the attachment placeholder
hint	str	❌	Hint of the attachment placeholder

SetEnvelopeDynamicFieldsRequest

Properties

Name	Type	Required	Description
dynamic_fields	List[DynamicField]	✅	List of dynamic fields

Page

Properties

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

TemplateSigningStep

Properties

Name	Type	Required	Description
recipients	List[TemplateRecipient]	❌	List of recipients

AttachmentPlaceholdersPerRecipient

Properties

Name	Type	Required	Description
recipient_id	str	❌	ID of the recipient
recipient_name	str	❌	Name of the recipient
placeholders	List[AttachmentPlaceholder]	❌

ListEnvelopesResponse

Properties

Name	Type	Required	Description
has_next_page	bool	❌	Whether there is a next page
has_previous_page	bool	❌	Whether there is a previous page
envelopes	List[Envelope]	❌

Recipient

Properties

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

WebhookEvent

Event of the webhook Properties

Name	Type	Required	Description
ENVELOPEEXPIRED	str	✅	“ENVELOPE_EXPIRED”
ENVELOPEDECLINED	str	✅	“ENVELOPE_DECLINED”
ENVELOPEVOIDED	str	✅	“ENVELOPE_VOIDED”
ENVELOPECOMPLETED	str	✅	“ENVELOPE_COMPLETED”
ENVELOPEAUDITTRAIL	str	✅	“ENVELOPE_AUDIT_TRAIL”

CreateWebhookRequest

Properties

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

CreateEnvelopeFromTemplateRequest

Properties

Name	Type	Required	Description
name	str	✅	Name of the envelope
comment	str	❌	Comment for the envelope
sandbox	bool	❌	Whether the envelope is created in sandbox mode

ListTemplateAnnotationsResponse

Properties

Name	Type	Required	Description
annotations	List[Annotation]	❌

RenameEnvelopeRequest

Properties

Name	Type	Required	Description
name	str	❌	Name of the envelope

ListTemplateDocumentAnnotationsResponse

Properties

Name	Type	Required	Description
annotations	List[Annotation]	❌

ListEnvelopeDocumentsResponse

Properties

Name	Type	Required	Description
documents	List[Document]	❌

ListWebhooksResponse

Properties

Name	Type	Required	Description
webhooks	List[Webhook]	❌

AnnotationSignature

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

Name	Type	Required	Description
id_	str	❌	Unique identifier of the annotation signature

Get Started

Concepts

Guides

Backend SDKs

API Reference

​create_envelope

​create_envelope_from_template

​list_envelopes

​get_envelope

​delete_envelope

​download_envelope_signed_documents

​download_envelope_certificate

​get_envelope_document

​get_envelope_documents

​add_envelope_document

​set_envelope_dynamic_fields

​add_envelope_signing_steps

​set_envelope_attachments_settings

​set_envelope_attachments_placeholders

​get_attachment_file

​send_envelope

​duplicate_envelope

​void_envelope

​rename_envelope

​set_envelope_comment

​set_envelope_notification

​set_envelope_expiration_date

​set_envelope_legality_level

​get_envelope_annotations

​get_envelope_document_annotations

​add_envelope_annotation

​delete_envelope_annotation

​create_template

​list_templates

​get_template

​delete_template

​duplicate_template

​add_template_document

​get_template_document

​get_template_documents

​add_template_signing_steps

​rename_template

​set_template_comment

​set_template_notification

​get_template_annotations

​get_document_template_annotations

​add_template_annotation

​delete_template_annotation

​set_template_attachments_settings

​set_template_attachments_placeholders

​create_webhook

​list_webhooks

​delete_webhook

​Models

​SetEnvelopeAttachmentsPlaceholdersRequest

​Document

​CreateEnvelopeRequest

​ListEnvelopesRequest

​AttachmentPlaceholder

​SetEnvelopeAttachmentsSettingsRequest

​EnvelopeNotification

​ListTemplatesRequest

​SetTemplateCommentRequest

​Template

​RecipientVerificationType

​AddEnvelopeSigningStepsRequest

​AnnotationFontFamily

​AddTemplateSigningStepsRequest

​SetEnvelopeCommentRequest

​TemplateOrderField

​EnvelopeOrderField

​AddEnvelopeDocumentRequest

​ListWebhooksRequest

​SetEnvelopeLegalityLevelRequest

​AttachmentPlaceholderFile

​SetEnvelopeExpirationRequest

​AnnotationText

​AnnotationCheckbox

​Envelope

​AddTemplateDocumentRequest

create_envelope

create_envelope_from_template

list_envelopes

get_envelope

delete_envelope

download_envelope_signed_documents

download_envelope_certificate

get_envelope_document

get_envelope_documents

add_envelope_document

set_envelope_dynamic_fields

add_envelope_signing_steps

set_envelope_attachments_settings

set_envelope_attachments_placeholders

get_attachment_file

send_envelope

duplicate_envelope

void_envelope

rename_envelope

set_envelope_comment

set_envelope_notification

set_envelope_expiration_date

set_envelope_legality_level

get_envelope_annotations

get_envelope_document_annotations

add_envelope_annotation

delete_envelope_annotation

create_template

list_templates

get_template

delete_template

duplicate_template

add_template_document

get_template_document

get_template_documents

add_template_signing_steps

rename_template

set_template_comment

set_template_notification

get_template_annotations

get_document_template_annotations

add_template_annotation

delete_template_annotation

set_template_attachments_settings

set_template_attachments_placeholders

create_webhook

list_webhooks

delete_webhook

Models

SetEnvelopeAttachmentsPlaceholdersRequest

Document

CreateEnvelopeRequest

ListEnvelopesRequest

AttachmentPlaceholder

SetEnvelopeAttachmentsSettingsRequest

EnvelopeNotification

ListTemplatesRequest

SetTemplateCommentRequest

Template

RecipientVerificationType

AddEnvelopeSigningStepsRequest

AnnotationFontFamily

AddTemplateSigningStepsRequest

SetEnvelopeCommentRequest

TemplateOrderField

EnvelopeOrderField

AddEnvelopeDocumentRequest

ListWebhooksRequest

SetEnvelopeLegalityLevelRequest

AttachmentPlaceholderFile

SetEnvelopeExpirationRequest

AnnotationText

AnnotationCheckbox

Envelope

AddTemplateDocumentRequest

TemplateRecipient

AddAnnotationRequest

ListEnvelopeDocumentAnnotationsResponse

EnvelopeStatus

RecipientVerification