> ## Documentation Index > Fetch the complete documentation index at: https://apidoc.sign.plus/llms.txt > Use this file to discover all available pages before exploring further. # Sdk reference 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_envelope) | Create new envelope | | [create\_envelope\_from\_template](#create_envelope_from_template) | Create new envelope from template | | [list\_envelopes](#list_envelopes) | List envelopes | | [get\_envelope](#get_envelope) | Get envelope | | [delete\_envelope](#delete_envelope) | Delete envelope | | [download\_envelope\_signed\_documents](#download_envelope_signed_documents) | Download signed documents for an envelope | | [download\_envelope\_certificate](#download_envelope_certificate) | Download certificate of completion for an envelope | | [get\_envelope\_document](#get_envelope_document) | Get envelope document | | [get\_envelope\_documents](#get_envelope_documents) | Get envelope documents | | [add\_envelope\_document](#add_envelope_document) | Add envelope document | | [set\_envelope\_dynamic\_fields](#set_envelope_dynamic_fields) | Set envelope dynamic fields | | [add\_envelope\_signing\_steps](#add_envelope_signing_steps) | Add envelope signing steps | | [set\_envelope\_attachments\_settings](#set_envelope_attachments_settings) | Set envelope attachment settings | | [set\_envelope\_attachments\_placeholders](#set_envelope_attachments_placeholders) | Placeholders to be set, completely replacing the existing ones. | | [get\_attachment\_file](#get_attachment_file) | Get envelope attachment file | | [send\_envelope](#send_envelope) | Send envelope for signature | | [duplicate\_envelope](#duplicate_envelope) | Duplicate envelope | | [void\_envelope](#void_envelope) | Void envelope | | [rename\_envelope](#rename_envelope) | Rename envelope | | [set\_envelope\_comment](#set_envelope_comment) | Set envelope comment | | [set\_envelope\_notification](#set_envelope_notification) | Set envelope notification | | [set\_envelope\_expiration\_date](#set_envelope_expiration_date) | Set envelope expiration date | | [set\_envelope\_legality\_level](#set_envelope_legality_level) | Set envelope legality level | | [get\_envelope\_annotations](#get_envelope_annotations) | Get envelope annotations | | [get\_envelope\_document\_annotations](#get_envelope_document_annotations) | Get envelope document annotations | | [add\_envelope\_annotation](#add_envelope_annotation) | Add envelope annotation | | [delete\_envelope\_annotation](#delete_envelope_annotation) | Delete envelope annotation | | [create\_template](#create_template) | Create new template | | [list\_templates](#list_templates) | List templates | | [get\_template](#get_template) | Get template | | [delete\_template](#delete_template) | Delete template | | [duplicate\_template](#duplicate_template) | Duplicate template | | [add\_template\_document](#add_template_document) | Add template document | | [get\_template\_document](#get_template_document) | Get template document | | [get\_template\_documents](#get_template_documents) | Get template documents | | [add\_template\_signing\_steps](#add_template_signing_steps) | Add template signing steps | | [rename\_template](#rename_template) | Rename template | | [set\_template\_comment](#set_template_comment) | Set template comment | | [set\_template\_notification](#set_template_notification) | Set template notification | | [get\_template\_annotations](#get_template_annotations) | Get template annotations | | [get\_document\_template\_annotations](#get_document_template_annotations) | Get document template annotations | | [add\_template\_annotation](#add_template_annotation) | Add template annotation | | [delete\_template\_annotation](#delete_template_annotation) | Delete template annotation | | [set\_template\_attachments\_settings](#set_template_attachments_settings) | Set template attachment settings | | [set\_template\_attachments\_placeholders](#set_template_attachments_placeholders) | Placeholders to be set, completely replacing the existing ones. | | [create\_webhook](#create_webhook) | Create webhook | | [list\_webhooks](#list_webhooks) | List webhooks | | [delete\_webhook](#delete_webhook) | Delete webhook | ## create\_envelope Create new envelope * HTTP Method: `POST` * Endpoint: `/envelope` **Parameters** | Name | Type | Required | Description | | :------------ | :----------------------------------------------------------------------------- | :------- | :---------------- | | request\_body | [CreateEnvelopeRequest](/api-reference/endpoints/signplus/create-new-envelope) | ✅ | The request body. | **Return Type** `Envelope` **Example Usage Code Snippet** ```python theme={null} 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](/api-reference/endpoints/signplus/create-new-envelope-from-template) | ✅ | The request body. | | template\_id | str | ✅ | | **Return Type** `Envelope` **Example Usage Code Snippet** ```python theme={null} 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](/api-reference/endpoints/signplus/list-envelopes) | ❌ | The request body. | **Return Type** `ListEnvelopesResponse` **Example Usage Code Snippet** ```python theme={null} 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** ```python theme={null} 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** ```python theme={null} 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** ```python theme={null} 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** ```python theme={null} 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** ```python theme={null} 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** ```python theme={null} 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](/api-reference/endpoints/signplus/add-envelope-document) | ✅ | The request body. | | envelope\_id | str | ✅ | | **Return Type** `Document` **Example Usage Code Snippet** ```python theme={null} 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](/api-reference/endpoints/signplus/set-envelope-dynamic-fields) | ✅ | The request body. | | envelope\_id | str | ✅ | | **Return Type** `Envelope` **Example Usage Code Snippet** ```python theme={null} 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](/api-reference/endpoints/signplus/add-envelope-signing-steps) | ✅ | The request body. | | envelope\_id | str | ✅ | | **Return Type** `Envelope` **Example Usage Code Snippet** ```python theme={null} 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](/api-reference/endpoints/signplus/set-envelope-attachment-settings) | ✅ | The request body. | | envelope\_id | str | ✅ | | **Return Type** `EnvelopeAttachments` **Example Usage Code Snippet** ```python theme={null} 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](/api-reference/endpoints/signplus/set-envelope-attachment-placeholders) | ✅ | The request body. | | envelope\_id | str | ✅ | | **Return Type** `EnvelopeAttachments` **Example Usage Code Snippet** ```python theme={null} 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** ```python theme={null} 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** ```python theme={null} 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** ```python theme={null} 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** ```python theme={null} 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](/api-reference/endpoints/signplus/rename-envelope) | ✅ | The request body. | | envelope\_id | str | ✅ | | **Return Type** `Envelope` **Example Usage Code Snippet** ```python theme={null} 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](/api-reference/endpoints/signplus/set-envelope-comment) | ✅ | The request body. | | envelope\_id | str | ✅ | | **Return Type** `Envelope` **Example Usage Code Snippet** ```python theme={null} 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](/api-reference/endpoints/signplus/set-envelope-notification) | ✅ | The request body. | | envelope\_id | str | ✅ | | **Return Type** `Envelope` **Example Usage Code Snippet** ```python theme={null} 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](/api-reference/endpoints/signplus/set-envelope-expiration-date) | ✅ | The request body. | | envelope\_id | str | ✅ | | **Return Type** `Envelope` **Example Usage Code Snippet** ```python theme={null} 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](/api-reference/endpoints/signplus/set-envelope-legality-level) | ✅ | The request body. | | envelope\_id | str | ✅ | | **Return Type** `Envelope` **Example Usage Code Snippet** ```python theme={null} 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** ```python theme={null} 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** ```python theme={null} 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](/api-reference/endpoints/signplus/add-envelope-annotation) | ✅ | The request body. | | envelope\_id | str | ✅ | ID of the envelope | **Return Type** `Annotation` **Example Usage Code Snippet** ```python theme={null} 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** ```python theme={null} 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](/api-reference/endpoints/signplus/create-new-template) | ✅ | The request body. | **Return Type** `Template` **Example Usage Code Snippet** ```python theme={null} 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](/api-reference/endpoints/signplus/list-templates) | ❌ | The request body. | **Return Type** `ListTemplatesResponse` **Example Usage Code Snippet** ```python theme={null} 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** ```python theme={null} 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** ```python theme={null} 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** ```python theme={null} 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](/api-reference/endpoints/signplus/add-template-document) | ✅ | The request body. | | template\_id | str | ✅ | | **Return Type** `Document` **Example Usage Code Snippet** ```python theme={null} 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** ```python theme={null} 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** ```python theme={null} 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](/api-reference/endpoints/signplus/add-template-signing-steps) | ✅ | The request body. | | template\_id | str | ✅ | | **Return Type** `Template` **Example Usage Code Snippet** ```python theme={null} 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](/api-reference/endpoints/signplus/rename-template) | ✅ | The request body. | | template\_id | str | ✅ | | **Return Type** `Template` **Example Usage Code Snippet** ```python theme={null} 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](/api-reference/endpoints/signplus/set-template-comment) | ✅ | The request body. | | template\_id | str | ✅ | | **Return Type** `Template` **Example Usage Code Snippet** ```python theme={null} 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](/api-reference/endpoints/signplus/set-envelope-notification) | ✅ | The request body. | | template\_id | str | ✅ | | **Return Type** `Template` **Example Usage Code Snippet** ```python theme={null} 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** ```python theme={null} 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** ```python theme={null} 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](/api-reference/endpoints/signplus/add-envelope-annotation) | ✅ | The request body. | | template\_id | str | ✅ | ID of the template | **Return Type** `Annotation` **Example Usage Code Snippet** ```python theme={null} 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** ```python theme={null} 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](/api-reference/endpoints/signplus/set-envelope-attachment-settings) | ✅ | The request body. | | template\_id | str | ✅ | | **Return Type** `EnvelopeAttachments` **Example Usage Code Snippet** ```python theme={null} 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](/api-reference/endpoints/signplus/set-envelope-attachment-placeholders) | ✅ | The request body. | | template\_id | str | ✅ | | **Return Type** `EnvelopeAttachments` **Example Usage Code Snippet** ```python theme={null} 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](/api-reference/endpoints/signplus/create-webhook) | ✅ | The request body. | **Return Type** `Webhook` **Example Usage Code Snippet** ```python theme={null} 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](/api-reference/endpoints/signplus/list-webhooks) | ❌ | The request body. | **Return Type** `ListWebhooksResponse` **Example Usage Code Snippet** ```python theme={null} 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** ```python theme={null} 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 |