DocuSign.Api.Envelopes (DocuSign v2.0.0)

View Source

API calls for all endpoints tagged Envelopes.

Summary

Functions

audit_events_get_audit_events(connection, account_id, envelope_id, opts \\ [])

Gets the envelope audit events for an envelope. Gets the envelope audit events for the specified envelope.

envelopes_get_envelope(connection, account_id, envelope_id, opts \\ [])

Gets the status of a single envelope. Retrieves the overall status for the specified envelope. To get the status of a list of envelopes, use Envelope: listStatusChanges . ### Related topics - How to get envelope information

envelopes_get_envelopes(connection, account_id, opts \\ [])

Search for specific sets of envelopes by using search filters. This method lets you search for envelopes in your accounts. A large set of filters let you narrow the scope of your search by date, by envelope ID, or by status codes. Your request must include one or more of the following parameters: from_date envelope_ids * transaction_ids ### Restrictions The number of envelopes returned is limited to 1,000 per call. To retrieve the next or previous set of envelopes, use the nextUri and previousUri parameters returned in the original call's response. If no from_date query parameter is specified, envelopes from more than two years ago will not be returned. To fetch older envelopes, set the specific date range using the from_date and to_date parameters. To avoid unnecessary database queries, the Docusign signature platform first checks requests to ensure that the filter set supplied does not result in a zero-size response before querying the database. ### Envelope statuses This table shows the valid current envelope statuses (status parameter) for the different status qualifiers (from_to_status parameter) in the request. If the status and status qualifiers in the API request do not contain any of the values shown in the Valid Current Statuses column, then an empty list is returned. Client applications should check that the statuses (status parameter) they are requesting make sense for a given from_to_status parameter value. | Status Qualifier<br>(from_to_status) | Effective Status Qualifier | Valid Current Statuses | | :------------------------------------- | :------------------------- | :-------------------------------------------------------------------------- | | any (changed) | StatusChanged | any, created, sent, delivered, signed, completed, declined, voided, deleted | | created | Created | any, created, sent, delivered, signed, completed, declined, voided, deleted | | sent | Sent | any, sent, delivered, signed, completed, declined, voided, deleted | | delivered | StatusChanged | any, delivered, signed, completed, declined, voided, deleted | | signed | StatusChanged | any, signed, completed, declined, voided, deleted | | completed | Completed | any, completed, declined, voided, deleted | | declined | StatusChanged | any, declined, voided, deleted | | timedout<br>always return zero results | StatusChanged | any, voided, deleted | | voided | Voided | any, voided, deleted | | deleted | StatusChanged | any, deleted | ### Extraneous results In some cases, a request for a specific envelope status will include envelopes with additional statuses. For example, in a request with a from_date of 2017-01-01, a to_date of 2017-01-07 and the status qualifier (from_to_status) set to delivered, the response set might contain envelopes that were created during that time period, but not delivered during the time period. As a workaround, check the envelope status values in the result set as needed. ### Related topics - Searching for envelopes - How to list envelope status changes

envelopes_post_envelopes(connection, account_id, opts \\ [])

Creates an envelope. Creates and sends an envelope or creates a draft envelope. Envelopes are fundamental resources in the Docusign platform. With this method you can: Create and send an envelope with [documents][], [recipients][], and [tabs][]. Create and send an envelope from a template. Create and send an envelope from a combination of documents and templates. Create a draft envelope. When you use this method to create and send an envelope in a single request, the following parameters in the request body (an [envelopeDefinition][envelopeDefinition] object) are required: | Parameter | Description | | :-------- | :---------- | | status | Set to sent to send the envelope to recipients.<br>Set to created (or don't set at all) to save the envelope as a draft. | | emailSubject | The subject of the email used to send the envelope. | | documents | The [documents][] to be signed. | | recipients | The email addresses of the envelope [recipients][]. | When you create an envelope by using a composite template, you should specify the envelope custom fields in the inline template. Any custom fields that you specify at the root level are ignored. If the envelope has a workflow definition and the workflowStatus is paused, the envelope will not be sent immediately, even if the envelope's status is sent. ### Related topics [Envelope][envelopes] and [template][templates] objects along with [documents][documents], [recipients][recipients], and [tabs][tabs] are the five object models at the core of the eSignature API. The eSignature concepts guide describes how the five object models work together. The following how-to articles contain practical examples that show you how to to configure this method's [envelopeDefinition][envelopeDefinition] request body to perform common tasks. Requesting a signature - How to request a signature by email - How to request a signature through your app - How to request a signature by email using a template - How to request a signature using a composite template - How to request a signature by SMS or WhatsApp delivery - How to send a request for payment - How to send an envelope to an In Person Signer - How to request a signature by email using CORS - How to request a signature through your CORS-enabled browser app - How to request a signature through your app (embedded signing) with a CFR Part 11 account Working with envelopes and templates - How to get envelope information - How to list envelope recipients - How to list envelope status changes - How to create a template - How to send an envelope via your app - How to bulk send envelopes Working with advanced recipient routing - How to pause a signature workflow - How to unpause a signature workflow - How to use conditional recipients - How to schedule an envelope - How to send an envelope with delayed routing Working with documents - How to list envelope documents - How to download envelope documents - How to attach documents via binary transfer - How to create a signable HTML document - How to convert a PDF file into a signable HTML document - How to set document visibility for envelope recipients - How to request a signature by email with document generation Working with tabs - How to get envelope tab values - How to get envelope custom tab values - How to set envelope tab values - How to set tab values in a template Working with brands - How to create a brand - How to apply a brand to an envelope - How to apply a brand and template to an envelope Working with permissions - How to create a permission profile - How to update individual permission settings - How to set a permission profile - How to delete a permission profile Implementing multi-factor recipient (signer) authentication - How to require ID verification (IDV) for a recipient - How to require knowledge-based authentication (KBA) for a recipient - How to require phone authentication for a recipient - How to require access code authentication for a recipient <!-- this should mirror /docs/esign-rest-api/how-to/ --> [addingdocs]: /docs/esign-rest-api/esign101/concepts/envelopes/ [attachments]: /docs/esign-rest-api/esign101/concepts/documents/attachments/ [authcopies]: /docs/esign-rest-api/esign101/concepts/documents/authoritative-copies/ [conoverview]: /docs/esign-rest-api/esign101/concepts/overview/ [deleting]: /docs/esign-rest-api/esign101/concepts/envelopes/ [documents]: /docs/esign-rest-api/esign101/concepts/documents/ [envelopeDefinition]: /docs/esign-rest-api/reference/envelopes/envelopes/create/#schema__envelopedefinition [envelopes]: /docs/esign-rest-api/esign101/concepts/envelopes/ [locking]: /docs/esign-rest-api/esign101/concepts/envelopes/lock/ [payments]: /docs/esign-rest-api/esign101/concepts/tabs/payment/ [purging]: /docs/esign-rest-api/esign101/concepts/documents/purging/ [recipients]: /docs/esign-rest-api/esign101/concepts/recipients/ [recipstatus]: /docs/esign-rest-api/esign101/concepts/recipients/#recipient-status [reciptypes]: /docs/esign-rest-api/esign101/concepts/recipients/#recipient-types [supdocs]: /docs/esign-rest-api/esign101/concepts/documents/supplemental/ [tabanchor]: /docs/esign-rest-api/esign101/concepts/tabs/auto-place/ [tabcustom]: /docs/esign-rest-api/esign101/concepts/tabs/custom-tabs/ [tabs]: /docs/esign-rest-api/esign101/concepts/tabs/ [tabtypes]: /docs/esign-rest-api/esign101/concepts/tabs/ [templates]: /docs/esign-rest-api/esign101/concepts/templates/ [tracking]: /docs/esign-rest-api/esign101/concepts/envelopes/

envelopes_put_envelope(connection, account_id, envelope_id, opts \\ [])

Send, void, or modify a draft envelope. Purge documents from a completed envelope. This method enables you to make changes to an envelope. You can use it to: Send a draft envelope Void an in-process envelope Modify a draft envelope Purge documents and envelope metadata from the Docusign platform Although the request body for this method is a complete envelope definition, you only need to provide the properties that you're updating. ## Sending a draft envelope To send a draft envelope, include the following code in the request body: json { "status": "sent" } You can attach a workflow before sending the envelope: json { "status": "sent", "workflow": { "workflowSteps": [ { "action": "pause_before", "description": "pause_before routing order 2", "itemId": 2, "triggerOnItem": "routing_order" } ] } } ## Working with workflows To unpause a workflow, the request body should include this: json { "workflow": { "workflowStatus": "in_progress" } } ## Voiding an in-process envelope To void an in-process envelope, include the following code in the request body: json { "status": "voided", "voidedReason": "The reason for voiding the envelope" } ## Modifying envelope email information To change the email subject and message of a draft envelope, include the following code in the request body: json { "emailSubject": "new email subject", "emailBlurb": "new email message" } ## Purging documents from Docusign To place only the documents in the purge queue, leaving any corresponding attachments and tabs in the Docusign platform, set the purgeState property to documents_queued. json { "envelopeId": "222e6847-xxxx-xxxx-xxxx-72a3c9c16fca", "purgeState": "documents_queued" } To place documents, attachments, and tabs in the purge queue, set the purgeState property to documents_and_metadata_queued. json { "envelopeId": "222e6847-xxxx-xxxx-xxxx-72a3c9c16fca", "purgeState": "documents_and_metadata_queued" } To place documents, attachments, and tabs in the purge queue and to redact personal information, set the purgeState property to documents_and_metadata_and_redact_queued. json { "envelopeId": "222e6847-xxxx-xxxx-xxxx-72a3c9c16fca", "purgeState": "documents_and_metadata_and_redact_queued" } You can purge documents only from completed envelopes that are not marked as the authoritative copy. The user requesting the purge must have permission to purge documents and must be the sender or be acting on behalf of the sender. When the purge request is initiated the items to be purged are placed in the purge queue for deletion in 14 days. The sender and all recipients with Docusign accounts associated with the envelope get an email notification the documents will be deleted in 14 days. The notification contains a link to the documents. A second email notification is sent 7 days later. At the end of the 14-day period the documents are deleted from the system. Recipients without Docusign accounts do not receive email notifications. If your account has a Document Retention policy, envelope documents are automatically placed in the purge queue, and notification emails are sent at the end of the retention period. Setting a Document Retention policy is the same as setting a schedule for purging documents. ## Removing documents from the purge queue To remove documents from the purge queue, include the following code in the request body: json { "envelopeId": "222e6847-xxxx-xxxx-xxxx-72a3c9c16fca", "purgeState": "documents_dequeued" } ### Related topics - Void an envelope (Common API Tasks) - Purging documents (eSignature Concepts) - Purging documents in an envelope (blog post) - How to unpause a signature workflow

envelopes_put_status(connection, account_id, opts \\ [])

Gets envelope statuses for a set of envelopes. Retrieves envelope statuses for a set of envelopes. Envelopes: listStatus has both a GET and a PUT implementation: PUT /restapi/v2.1/accounts/{accountId}/envelopes/status is passed a set of envelope IDs in the request body. This version of the method returns a smaller subset of envelope information. GET /restapi/v2.1/accounts/{accountId}/envelopes/status is passed a list of envelope IDs in a query string. <ds-inlinemessage> To search for envelopes using a broad range of filters, use <a href="/docs/esign-rest-api/reference/envelopes/envelopes/liststatuschanges/">Envelopes: listStatusChanges</a> instead of this method. </ds-inlinemessage> You must specify exactly one of the following query parameters: | Parameter | Description | | :---------------- | :------------------------------------------------------------------------------- | | from_date | a valid UTC DateTime: 2016-01-01 | | envelope_ids | <ul><li>For the <code>GET</code> implementation of this method, include the envelope IDs in a comma-separated list. </li><li>For the <code>PUT</code> version of this method, you should use the <code>request_body</code> value for this parameter and include the list of envelope IDs in the request body.</li></ul> | | transaction_ids | A comma-separated list of transaction IDs<br>or the special value <code>request_body</code> | When you use the special value request_body, the request body looks like this: { "envelopeIds": [ "44c5ad6c-xxxx-xxxx-xxxx-ebda5e2dfe15", "8e26040d-xxxx-xxxx-xxxx-1e29b924d237", "c8b40a2d-xxxx-xxxx-xxxx-4fe56fe10f95" ] } <ds-inlinemessage kind="warning"> Omitting the request body altogether causes the endpoint to return an error. The request body must be at least <code>{}</code>. </ds-inlinemessage> ### Related topics - Searching for envelopes - How to list envelope status changes

notification_get_envelopes_envelope_id_notification(connection, account_id, envelope_id, opts \\ [])

Gets envelope notification information. Retrieves the envelope notification, reminders and expirations, information for an existing envelope.

notification_put_envelopes_envelope_id_notification(connection, account_id, envelope_id, opts \\ [])

Sets envelope notifications for an existing envelope. This method sets the notifications (reminders and expirations) for an existing envelope. The request body sends a structure containing reminders and expirations settings. It also specifies whether to use the settings specified in the request, or the account default notification settings for the envelope. Note that this request only specifies when notifications are sent; it does not initiate sending of email messages.

pages_delete_page(connection, account_id, document_id, envelope_id, page_number, opts \\ [])

Deletes a page from a document in an envelope. Deletes a page from a document in an envelope based on the page number.

pages_get_page_image(connection, account_id, document_id, envelope_id, page_number, opts \\ [])

Gets a page image from an envelope for display. Returns an image of a page in a document for display.

pages_get_page_images(connection, account_id, document_id, envelope_id, opts \\ [])

Returns document page images based on input. Returns images of the pages in a document for display based on the parameters that you specify.

pages_put_page_image(connection, account_id, document_id, envelope_id, page_number, opts \\ [])

Rotates page image from an envelope for display. Rotates page image from an envelope for display. The page image can be rotated to the left or right.

recipients_get_recipient_initials_image(connection, account_id, envelope_id, recipient_id, opts \\ [])

Gets the initials image for a user. Retrieves the initials image for the specified recipient.

recipients_get_recipient_signature(connection, account_id, envelope_id, recipient_id, opts \\ [])

Gets signature information for a signer or sign-in-person recipient. Retrieves signature information for a signer or sign-in-person recipient.

recipients_get_recipient_signature_image(connection, account_id, envelope_id, recipient_id, opts \\ [])

Retrieve signature image information for a signer/sign-in-person recipient. Retrieves the specified recipient signature image.

recipients_put_recipient_initials_image(connection, account_id, envelope_id, recipient_id, opts \\ [])

Sets the initials image for an accountless signer. Updates the initials image for a signer that does not have a Docusign account. The supported image formats for this file are: gif, png, jpeg, and bmp. The file size must be less than 200K. For the Authentication/Authorization for this call, the credentials must match the sender of the envelope, the recipient must be an accountless signer or in person signer. The account must have the CanSendEnvelope property set to true and the ExpressSendOnly property in SendingUser structure must be set to false.

recipients_put_recipient_signature_image(connection, account_id, envelope_id, recipient_id, opts \\ [])

Sets the signature image for an accountless signer. Updates the signature image for an accountless signer. The supported image formats for this file are: gif, png, jpeg, and bmp. The file size must be less than 200K. For the Authentication/Authorization for this call, the credentials must match the sender of the envelope, the recipient must be an accountless signer or in person signer. The account must have the CanSendEnvelope property set to true and the ExpressSendOnly property in SendingUser structure must be set to false.

Functions

audit_events_get_audit_events(connection, account_id, envelope_id, opts \\ [])

@spec audit_events_get_audit_events(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword()
) ::
  {:ok, DocuSign.Model.EnvelopeAuditEventResponse.t()}
  | {:ok, DocuSign.Model.ErrorDetails.t()}
  | {:error, Tesla.Env.t()}

Gets the envelope audit events for an envelope. Gets the envelope audit events for the specified envelope.

Parameters

  • connection (DocuSign.Connection): Connection to server
  • account_id (String.t): The external account number (int) or account ID GUID.
  • envelope_id (String.t): The envelope's GUID. Example: 93be49ab-xxxx-xxxx-xxxx-f752070d71ec
  • opts (keyword): Optional parameters

Returns

  • {:ok, DocuSign.Model.EnvelopeAuditEventResponse.t} on success
  • {:error, Tesla.Env.t} on failure

envelopes_get_envelope(connection, account_id, envelope_id, opts \\ [])

@spec envelopes_get_envelope(Tesla.Env.client(), String.t(), String.t(), keyword()) ::
  {:ok, DocuSign.Model.Envelope.t()}
  | {:ok, DocuSign.Model.ErrorDetails.t()}
  | {:error, Tesla.Env.t()}

Gets the status of a single envelope. Retrieves the overall status for the specified envelope. To get the status of a list of envelopes, use Envelope: listStatusChanges . ### Related topics - How to get envelope information

Parameters

  • connection (DocuSign.Connection): Connection to server
  • account_id (String.t): The external account number (int) or account ID GUID.
  • envelope_id (String.t): The envelope's GUID. Example: 93be49ab-xxxx-xxxx-xxxx-f752070d71ec
  • opts (keyword): Optional parameters
    • :advanced_update (String.t): When true, envelope information can be added or modified.
    • :include (String.t): Specifies additional information about the envelope to return. Enter a comma-separated list, such as tabs,recipients. Valid values are: - custom_fields: The custom fields associated with the envelope. - documents: The documents associated with the envelope. - attachments: The attachments associated with the envelope. - extensions: The email settings associated with the envelope. - folders: The folder where the envelope exists. - recipients: The recipients associated with the envelope. - powerform: The PowerForms associated with the envelope. - prefill_tabs: The pre-filled tabs associated with the envelope. - tabs: The tabs associated with the envelope. - payment_tabs: The payment tabs associated with the envelope. - workflow: The workflow definition associated with the envelope.
    • :include_anchor_tab_locations (String.t): When true, all tabs with anchor tab properties are included in the response. The default value is false.

Returns

  • {:ok, DocuSign.Model.Envelope.t} on success
  • {:error, Tesla.Env.t} on failure

envelopes_get_envelopes(connection, account_id, opts \\ [])

@spec envelopes_get_envelopes(Tesla.Env.client(), String.t(), keyword()) ::
  {:ok, DocuSign.Model.ErrorDetails.t()}
  | {:ok, DocuSign.Model.EnvelopesInformation.t()}
  | {:error, Tesla.Env.t()}

Search for specific sets of envelopes by using search filters. This method lets you search for envelopes in your accounts. A large set of filters let you narrow the scope of your search by date, by envelope ID, or by status codes. Your request must include one or more of the following parameters: from_date envelope_ids * transaction_ids ### Restrictions The number of envelopes returned is limited to 1,000 per call. To retrieve the next or previous set of envelopes, use the nextUri and previousUri parameters returned in the original call's response. If no from_date query parameter is specified, envelopes from more than two years ago will not be returned. To fetch older envelopes, set the specific date range using the from_date and to_date parameters. To avoid unnecessary database queries, the Docusign signature platform first checks requests to ensure that the filter set supplied does not result in a zero-size response before querying the database. ### Envelope statuses This table shows the valid current envelope statuses (status parameter) for the different status qualifiers (from_to_status parameter) in the request. If the status and status qualifiers in the API request do not contain any of the values shown in the Valid Current Statuses column, then an empty list is returned. Client applications should check that the statuses (status parameter) they are requesting make sense for a given from_to_status parameter value. | Status Qualifier<br>(from_to_status) | Effective Status Qualifier | Valid Current Statuses | | :------------------------------------- | :------------------------- | :-------------------------------------------------------------------------- | | any (changed) | StatusChanged | any, created, sent, delivered, signed, completed, declined, voided, deleted | | created | Created | any, created, sent, delivered, signed, completed, declined, voided, deleted | | sent | Sent | any, sent, delivered, signed, completed, declined, voided, deleted | | delivered | StatusChanged | any, delivered, signed, completed, declined, voided, deleted | | signed | StatusChanged | any, signed, completed, declined, voided, deleted | | completed | Completed | any, completed, declined, voided, deleted | | declined | StatusChanged | any, declined, voided, deleted | | timedout<br>always return zero results | StatusChanged | any, voided, deleted | | voided | Voided | any, voided, deleted | | deleted | StatusChanged | any, deleted | ### Extraneous results In some cases, a request for a specific envelope status will include envelopes with additional statuses. For example, in a request with a from_date of 2017-01-01, a to_date of 2017-01-07 and the status qualifier (from_to_status) set to delivered, the response set might contain envelopes that were created during that time period, but not delivered during the time period. As a workaround, check the envelope status values in the result set as needed. ### Related topics - Searching for envelopes - How to list envelope status changes

Parameters

  • connection (DocuSign.Connection): Connection to server
  • account_id (String.t): The external account number (int) or account ID GUID.
  • opts (keyword): Optional parameters
    • :ac_status (String.t): Specifies the authoritative copy status for the envelopes. Valid values: Unknown Original Transferred AuthoritativeCopy AuthoritativeCopyExportPending AuthoritativeCopyExported DepositPending Deposited DepositedEO DepositFailed
    • :block (String.t): Reserved for Docusign.
    • :cdse_mode (String.t): Reserved for Docusign.
    • :continuation_token (String.t): Reserved for Docusign.
    • :count (String.t): The maximum number of results to return. The maximum value is 1000. To get the next or previous set of envelopes, use nextUri or previousUri from the response.
    • :custom_field (String.t): Optional. Specifies an envelope custom field name and value searched for in the envelopes. Format: custom_envelope_field_name=desired_value Example: If you have an envelope custom field named "Region" and you want to search for all envelopes where the value is "West" you would use set this parameter to Region=West.
    • :email (String.t): Limit results to envelopes sent by the account user with this email address. user_name must be given as well, and both email and user_name must refer to an existing account user.
    • :envelope_ids (String.t): Comma separated list of envelopeId values.
    • :exclude (String.t): Excludes information from the response. Enter as a comma-separated list (e.g., folders,powerforms). Valid values: - recipients - powerforms - folders
    • :folder_ids (String.t): Returns the envelopes from specific folders. Enter as a comma-separated list of either valid folder GUIDs or the following values: - awaiting_my_signature - completed - draft - drafts - expiring_soon - inbox - out_for_signature - recyclebin - sentitems - waiting_for_others
    • :folder_types (String.t): Returns the envelopes from folders of a specific type. Enter as a comma-separated list of the following values: - normal - inbox - sentitems - draft - templates
    • :from_date (String.t): Specifies the date and time to start looking for status changes. This parameter is required unless envelopeIds or transactionIds are set. Although you can use any date format supported by the .NET system library's [DateTime.Parse()][msoft] function, Docusign recommends using [ISO 8601][] format dates with an explicit time zone offset. If you do not provide a time zone offset, the method uses the server's time zone. For example, the following dates and times refer to the same instant: 2017-05-02T01:44Z 2017-05-01T21:44-04:00 * 2017-05-01T18:44-07:00 If this property is not included, envelopes from the last two years will be returned. [msoft]: https://docs.microsoft.com/en-us/dotnet/api/system.datetime.parse?redirectedfrom=MSDN&view=net-5.0#overloads [ISO 8601]: https://en.wikipedia.org/wiki/ISO_8601
    • :from_to_status (String.t): This is the status type checked for in the from_date/to_date period. For example, if Created is specified, then envelopes created during the period are found. If Changed is specified, then envelopes that changed status during the period are returned. The default value is Changed. Valid values: Changed Voided Created Deleted Sent Delivered Signed Completed Declined TimedOut * Processing
    • :include (String.t): Specifies additional information to return about the envelopes. Use a comma-separated list, such as folders, recipients to specify information. Valid values are: - custom_fields: The custom fields associated with the envelope. - documents: The documents associated with the envelope. - attachments: The attachments associated with the envelope. - extensions: Information about the email settings associated with the envelope. - folders: The folders where the envelope exists. - recipients: The recipients associated with the envelope. - payment_tabs: The payment tabs associated with the envelope.
    • :include_purge_information (String.t): When true, information about envelopes that have been deleted is included in the response.
    • :intersecting_folder_ids (String.t): A comma-separated list of folders from which you want to get envelopes. Valid values: - normal - inbox - sentitems - draft - templates
    • :last_queried_date (String.t): Returns envelopes that were modified prior to the specified date and time. Example: 2020-05-09T21:56:12.2500000Z
    • :order (String.t): Returns envelopes in either ascending (asc) or descending (desc) order.
    • :order_by (String.t): Sorts results according to a specific property. Valid values: - last_modified - action_required - created - completed - envelope_name - expire - sent - signer_list - status - subject - user_name - status_changed - last_modified
    • :powerformids (String.t): A comma-separated list of PowerFormId values.
    • :query_budget (String.t): The time in seconds that the query should run before returning data.
    • :requester_date_format (String.t):
    • :search_mode (String.t):
    • :search_text (String.t): Free text search criteria that you can use to filter the list of envelopes that is returned.
    • :start_position (String.t): The zero-based index of the result from which to start returning results. Use with count to limit the number of results. The default value is 0.
    • :status (String.t): A comma-separated list of current envelope statuses to be included in the response. Valid values: completed created declined deleted delivered processing sent signed timedout voided The any value is equivalent to any status.
    • :to_date (String.t): Specifies the date and time to stop looking for status changes. The default is the current date and time. Although you can use any date format supported by the .NET system library's [DateTime.Parse()][msoft] function, Docusign recommends using [ISO 8601][] format dates with an explicit time zone offset If you do not provide a time zone offset, the method uses the server's time zone. For example, the following dates and times refer to the same instant: 2017-05-02T01:44Z 2017-05-01T21:44-04:00 * 2017-05-01T18:44-07:00 [msoft]: https://docs.microsoft.com/en-us/dotnet/api/system.datetime.parse?redirectedfrom=MSDN&view=net-5.0#overloads [ISO 8601]: https://en.wikipedia.org/wiki/ISO_8601
    • :transaction_ids (String.t): A comma-separated list of envelope transaction IDs. Getting envelope status by transaction IDs is useful for offline signing situations to determine if an envelope was created or not. It can be used for the cases where a network connection was lost before the envelope status could be returned. Note: Transaction IDs are only valid in the Docusign system for seven days.
    • :user_filter (String.t): Returns envelopes where the current user is the recipient, the sender, or the recipient only. (For example, user_filter=sender.) Valid values are: - sender - recipient - recipient_only
    • :user_id (String.t): The ID of the user who created the envelopes to be retrieved. Note that an account can have multiple users, and any user with account access can retrieve envelopes by user_id from the account.
    • :user_name (String.t): Limit results to envelopes sent by the account user with this user name. email must be given as well, and both email and user_name must refer to an existing account user.

Returns

  • {:ok, DocuSign.Model.EnvelopesInformation.t} on success
  • {:error, Tesla.Env.t} on failure

envelopes_post_envelopes(connection, account_id, opts \\ [])

@spec envelopes_post_envelopes(Tesla.Env.client(), String.t(), keyword()) ::
  {:ok, DocuSign.Model.ErrorDetails.t()}
  | {:ok, DocuSign.Model.EnvelopeSummary.t()}
  | {:error, Tesla.Env.t()}

Creates an envelope. Creates and sends an envelope or creates a draft envelope. Envelopes are fundamental resources in the Docusign platform. With this method you can: Create and send an envelope with [documents][], [recipients][], and [tabs][]. Create and send an envelope from a template. Create and send an envelope from a combination of documents and templates. Create a draft envelope. When you use this method to create and send an envelope in a single request, the following parameters in the request body (an [envelopeDefinition][envelopeDefinition] object) are required: | Parameter | Description | | :-------- | :---------- | | status | Set to sent to send the envelope to recipients.<br>Set to created (or don't set at all) to save the envelope as a draft. | | emailSubject | The subject of the email used to send the envelope. | | documents | The [documents][] to be signed. | | recipients | The email addresses of the envelope [recipients][]. | When you create an envelope by using a composite template, you should specify the envelope custom fields in the inline template. Any custom fields that you specify at the root level are ignored. If the envelope has a workflow definition and the workflowStatus is paused, the envelope will not be sent immediately, even if the envelope's status is sent. ### Related topics [Envelope][envelopes] and [template][templates] objects along with [documents][documents], [recipients][recipients], and [tabs][tabs] are the five object models at the core of the eSignature API. The eSignature concepts guide describes how the five object models work together. The following how-to articles contain practical examples that show you how to to configure this method's [envelopeDefinition][envelopeDefinition] request body to perform common tasks. Requesting a signature - How to request a signature by email - How to request a signature through your app - How to request a signature by email using a template - How to request a signature using a composite template - How to request a signature by SMS or WhatsApp delivery - How to send a request for payment - How to send an envelope to an In Person Signer - How to request a signature by email using CORS - How to request a signature through your CORS-enabled browser app - How to request a signature through your app (embedded signing) with a CFR Part 11 account Working with envelopes and templates - How to get envelope information - How to list envelope recipients - How to list envelope status changes - How to create a template - How to send an envelope via your app - How to bulk send envelopes Working with advanced recipient routing - How to pause a signature workflow - How to unpause a signature workflow - How to use conditional recipients - How to schedule an envelope - How to send an envelope with delayed routing Working with documents - How to list envelope documents - How to download envelope documents - How to attach documents via binary transfer - How to create a signable HTML document - How to convert a PDF file into a signable HTML document - How to set document visibility for envelope recipients - How to request a signature by email with document generation Working with tabs - How to get envelope tab values - How to get envelope custom tab values - How to set envelope tab values - How to set tab values in a template Working with brands - How to create a brand - How to apply a brand to an envelope - How to apply a brand and template to an envelope Working with permissions - How to create a permission profile - How to update individual permission settings - How to set a permission profile - How to delete a permission profile Implementing multi-factor recipient (signer) authentication - How to require ID verification (IDV) for a recipient - How to require knowledge-based authentication (KBA) for a recipient - How to require phone authentication for a recipient - How to require access code authentication for a recipient <!-- this should mirror /docs/esign-rest-api/how-to/ --> [addingdocs]: /docs/esign-rest-api/esign101/concepts/envelopes/ [attachments]: /docs/esign-rest-api/esign101/concepts/documents/attachments/ [authcopies]: /docs/esign-rest-api/esign101/concepts/documents/authoritative-copies/ [conoverview]: /docs/esign-rest-api/esign101/concepts/overview/ [deleting]: /docs/esign-rest-api/esign101/concepts/envelopes/ [documents]: /docs/esign-rest-api/esign101/concepts/documents/ [envelopeDefinition]: /docs/esign-rest-api/reference/envelopes/envelopes/create/#schema__envelopedefinition [envelopes]: /docs/esign-rest-api/esign101/concepts/envelopes/ [locking]: /docs/esign-rest-api/esign101/concepts/envelopes/lock/ [payments]: /docs/esign-rest-api/esign101/concepts/tabs/payment/ [purging]: /docs/esign-rest-api/esign101/concepts/documents/purging/ [recipients]: /docs/esign-rest-api/esign101/concepts/recipients/ [recipstatus]: /docs/esign-rest-api/esign101/concepts/recipients/#recipient-status [reciptypes]: /docs/esign-rest-api/esign101/concepts/recipients/#recipient-types [supdocs]: /docs/esign-rest-api/esign101/concepts/documents/supplemental/ [tabanchor]: /docs/esign-rest-api/esign101/concepts/tabs/auto-place/ [tabcustom]: /docs/esign-rest-api/esign101/concepts/tabs/custom-tabs/ [tabs]: /docs/esign-rest-api/esign101/concepts/tabs/ [tabtypes]: /docs/esign-rest-api/esign101/concepts/tabs/ [templates]: /docs/esign-rest-api/esign101/concepts/templates/ [tracking]: /docs/esign-rest-api/esign101/concepts/envelopes/

Parameters

  • connection (DocuSign.Connection): Connection to server
  • account_id (String.t): The external account number (int) or account ID GUID.
  • opts (keyword): Optional parameters
    • :cdse_mode (String.t): Reserved for Docusign.
    • :change_routing_order (String.t): When true, users can define the routing order of recipients while sending documents for signature.
    • :completed_documents_only (String.t): Reserved for Docusign.
    • :merge_roles_on_draft (String.t): When true, template roles will be merged, and empty recipients will be removed. This parameter applies when you create a draft envelope with multiple templates. (To create a draft envelope, the status field is set to created.) Note: Docusign recommends that this parameter should be set to true whenever you create a draft envelope with multiple templates.
    • :body (EnvelopeDefinition):

Returns

  • {:ok, DocuSign.Model.EnvelopeSummary.t} on success
  • {:error, Tesla.Env.t} on failure

envelopes_put_envelope(connection, account_id, envelope_id, opts \\ [])

@spec envelopes_put_envelope(Tesla.Env.client(), String.t(), String.t(), keyword()) ::
  {:ok, DocuSign.Model.ErrorDetails.t()}
  | {:ok, DocuSign.Model.EnvelopeUpdateSummary.t()}
  | {:error, Tesla.Env.t()}

Send, void, or modify a draft envelope. Purge documents from a completed envelope. This method enables you to make changes to an envelope. You can use it to: Send a draft envelope Void an in-process envelope Modify a draft envelope Purge documents and envelope metadata from the Docusign platform Although the request body for this method is a complete envelope definition, you only need to provide the properties that you're updating. ## Sending a draft envelope To send a draft envelope, include the following code in the request body: json { "status": "sent" } You can attach a workflow before sending the envelope: json { "status": "sent", "workflow": { "workflowSteps": [ { "action": "pause_before", "description": "pause_before routing order 2", "itemId": 2, "triggerOnItem": "routing_order" } ] } } ## Working with workflows To unpause a workflow, the request body should include this: json { "workflow": { "workflowStatus": "in_progress" } } ## Voiding an in-process envelope To void an in-process envelope, include the following code in the request body: json { "status": "voided", "voidedReason": "The reason for voiding the envelope" } ## Modifying envelope email information To change the email subject and message of a draft envelope, include the following code in the request body: json { "emailSubject": "new email subject", "emailBlurb": "new email message" } ## Purging documents from Docusign To place only the documents in the purge queue, leaving any corresponding attachments and tabs in the Docusign platform, set the purgeState property to documents_queued. json { "envelopeId": "222e6847-xxxx-xxxx-xxxx-72a3c9c16fca", "purgeState": "documents_queued" } To place documents, attachments, and tabs in the purge queue, set the purgeState property to documents_and_metadata_queued. json { "envelopeId": "222e6847-xxxx-xxxx-xxxx-72a3c9c16fca", "purgeState": "documents_and_metadata_queued" } To place documents, attachments, and tabs in the purge queue and to redact personal information, set the purgeState property to documents_and_metadata_and_redact_queued. json { "envelopeId": "222e6847-xxxx-xxxx-xxxx-72a3c9c16fca", "purgeState": "documents_and_metadata_and_redact_queued" } You can purge documents only from completed envelopes that are not marked as the authoritative copy. The user requesting the purge must have permission to purge documents and must be the sender or be acting on behalf of the sender. When the purge request is initiated the items to be purged are placed in the purge queue for deletion in 14 days. The sender and all recipients with Docusign accounts associated with the envelope get an email notification the documents will be deleted in 14 days. The notification contains a link to the documents. A second email notification is sent 7 days later. At the end of the 14-day period the documents are deleted from the system. Recipients without Docusign accounts do not receive email notifications. If your account has a Document Retention policy, envelope documents are automatically placed in the purge queue, and notification emails are sent at the end of the retention period. Setting a Document Retention policy is the same as setting a schedule for purging documents. ## Removing documents from the purge queue To remove documents from the purge queue, include the following code in the request body: json { "envelopeId": "222e6847-xxxx-xxxx-xxxx-72a3c9c16fca", "purgeState": "documents_dequeued" } ### Related topics - Void an envelope (Common API Tasks) - Purging documents (eSignature Concepts) - Purging documents in an envelope (blog post) - How to unpause a signature workflow

Parameters

  • connection (DocuSign.Connection): Connection to server
  • account_id (String.t): The external account number (int) or account ID GUID.
  • envelope_id (String.t): The envelope's GUID. Example: 93be49ab-xxxx-xxxx-xxxx-f752070d71ec
  • opts (keyword): Optional parameters
    • :advanced_update (String.t): When true, allows the caller to update recipients, tabs, custom fields, notification, email settings and other envelope attributes.
    • :recycle_on_void (String.t):
    • :resend_envelope (String.t): When true, sends the specified envelope again.
    • :body (Envelope): A container used to send documents to recipients. The envelope carries information about the sender and timestamps to indicate the progress of the delivery procedure. It can contain collections of Documents, Tabs and Recipients.

Returns

  • {:ok, DocuSign.Model.EnvelopeUpdateSummary.t} on success
  • {:error, Tesla.Env.t} on failure

envelopes_put_status(connection, account_id, opts \\ [])

@spec envelopes_put_status(Tesla.Env.client(), String.t(), keyword()) ::
  {:ok, DocuSign.Model.ErrorDetails.t()}
  | {:ok, DocuSign.Model.EnvelopesInformation.t()}
  | {:error, Tesla.Env.t()}

Gets envelope statuses for a set of envelopes. Retrieves envelope statuses for a set of envelopes. Envelopes: listStatus has both a GET and a PUT implementation: PUT /restapi/v2.1/accounts/{accountId}/envelopes/status is passed a set of envelope IDs in the request body. This version of the method returns a smaller subset of envelope information. GET /restapi/v2.1/accounts/{accountId}/envelopes/status is passed a list of envelope IDs in a query string. <ds-inlinemessage> To search for envelopes using a broad range of filters, use <a href="/docs/esign-rest-api/reference/envelopes/envelopes/liststatuschanges/">Envelopes: listStatusChanges</a> instead of this method. </ds-inlinemessage> You must specify exactly one of the following query parameters: | Parameter | Description | | :---------------- | :------------------------------------------------------------------------------- | | from_date | a valid UTC DateTime: 2016-01-01 | | envelope_ids | <ul><li>For the <code>GET</code> implementation of this method, include the envelope IDs in a comma-separated list. </li><li>For the <code>PUT</code> version of this method, you should use the <code>request_body</code> value for this parameter and include the list of envelope IDs in the request body.</li></ul> | | transaction_ids | A comma-separated list of transaction IDs<br>or the special value <code>request_body</code> | When you use the special value request_body, the request body looks like this: { "envelopeIds": [ "44c5ad6c-xxxx-xxxx-xxxx-ebda5e2dfe15", "8e26040d-xxxx-xxxx-xxxx-1e29b924d237", "c8b40a2d-xxxx-xxxx-xxxx-4fe56fe10f95" ] } <ds-inlinemessage kind="warning"> Omitting the request body altogether causes the endpoint to return an error. The request body must be at least <code>{}</code>. </ds-inlinemessage> ### Related topics - Searching for envelopes - How to list envelope status changes

Parameters

  • connection (DocuSign.Connection): Connection to server
  • account_id (String.t): The external account number (int) or account ID GUID.
  • opts (keyword): Optional parameters
    • :ac_status (String.t): Specifies the Authoritative Copy Status for the envelopes. Valid values: - Unknown - Original - Transferred - AuthoritativeCopy - AuthoritativeCopyExportPending - AuthoritativeCopyExported - DepositPending - Deposited - DepositedEO - DepositFailed
    • :block (String.t): When true, removes any results that match one of the provided transaction_ids.
    • :count (String.t): The maximum number of results to return. Use start_position to specify the number of results to skip.
    • :email (String.t): The email address of the sender.
    • :envelope_ids (String.t): The envelope IDs to include in the results. The value of this property can be: For the GET implementation of this method, use a comma-separated list of envelope IDs. For the PUT implementation of this method, use the request_body value, and include the envelope IDs in the request body.
    • :from_date (String.t): The date/time setting that specifies when the request begins checking for status changes for envelopes in the account. This is required unless parameters envelope_ids and/or transaction_Ids are provided. Note: This parameter must be set to a valid DateTime, or envelope_ids and/or transaction_ids must be specified.
    • :from_to_status (String.t): The envelope status that you are checking for. Possible values are: - Changed (default) - Completed - Created - Declined - Deleted - Delivered - Processing - Sent - Signed - TimedOut - Voided For example, if you specify Changed, this method returns a list of envelopes that changed status during the from_date to to_date time period.
    • :start_position (String.t): The zero-based index of the result from which to start returning results. Use with count to limit the number of results. The default value is 0.
    • :status (String.t): A comma-separated list of envelope status to search for. Possible values are: - completed - created - declined - deleted - delivered - processing - sent - signed - template - voided
    • :to_date (String.t): Optional date/time setting that specifies the last date/time or envelope status changes in the result set. The default value is the time that you call the method.
    • :transaction_ids (String.t): The transaction IDs to include in the results. Note that transaction IDs are valid for seven days. The value of this property can be: - A list of comma-separated transaction IDs - The special value request_body. In this case, this method uses the transaction IDs in the request body.
    • :user_name (String.t): Limits results to envelopes sent by the account user with this user name. email must be given as well, and both email and user_name must refer to an existing account user.
    • :body (EnvelopeIdsRequest):

Returns

  • {:ok, DocuSign.Model.EnvelopesInformation.t} on success
  • {:error, Tesla.Env.t} on failure

notification_get_envelopes_envelope_id_notification(connection, account_id, envelope_id, opts \\ [])

@spec notification_get_envelopes_envelope_id_notification(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword()
) ::
  {:ok, DocuSign.Model.ErrorDetails.t()}
  | {:ok, DocuSign.Model.Notification.t()}
  | {:error, Tesla.Env.t()}

Gets envelope notification information. Retrieves the envelope notification, reminders and expirations, information for an existing envelope.

Parameters

  • connection (DocuSign.Connection): Connection to server
  • account_id (String.t): The external account number (int) or account ID GUID.
  • envelope_id (String.t): The envelope's GUID. Example: 93be49ab-xxxx-xxxx-xxxx-f752070d71ec
  • opts (keyword): Optional parameters

Returns

  • {:ok, DocuSign.Model.Notification.t} on success
  • {:error, Tesla.Env.t} on failure

notification_put_envelopes_envelope_id_notification(connection, account_id, envelope_id, opts \\ [])

@spec notification_put_envelopes_envelope_id_notification(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  keyword()
) ::
  {:ok, DocuSign.Model.ErrorDetails.t()}
  | {:ok, DocuSign.Model.Notification.t()}
  | {:error, Tesla.Env.t()}

Sets envelope notifications for an existing envelope. This method sets the notifications (reminders and expirations) for an existing envelope. The request body sends a structure containing reminders and expirations settings. It also specifies whether to use the settings specified in the request, or the account default notification settings for the envelope. Note that this request only specifies when notifications are sent; it does not initiate sending of email messages.

Parameters

  • connection (DocuSign.Connection): Connection to server
  • account_id (String.t): The external account number (int) or account ID GUID.
  • envelope_id (String.t): The envelope's GUID. Example: 93be49ab-xxxx-xxxx-xxxx-f752070d71ec
  • opts (keyword): Optional parameters
    • :body (EnvelopeNotificationRequest):

Returns

  • {:ok, DocuSign.Model.Notification.t} on success
  • {:error, Tesla.Env.t} on failure

pages_delete_page(connection, account_id, document_id, envelope_id, page_number, opts \\ [])

@spec pages_delete_page(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  String.t(),
  String.t(),
  keyword()
) ::
  {:ok, nil} | {:ok, DocuSign.Model.ErrorDetails.t()} | {:error, Tesla.Env.t()}

Deletes a page from a document in an envelope. Deletes a page from a document in an envelope based on the page number.

Parameters

  • connection (DocuSign.Connection): Connection to server
  • account_id (String.t): The external account number (int) or account ID GUID.
  • document_id (String.t): The unique ID of the document within the envelope. Unlike other IDs in the eSignature API, you specify the documentId yourself. Typically the first document has the ID 1, the second document 2, and so on, but you can use any numbering scheme that fits within a 32-bit signed integer (1 through 2147483647). Tab objects have a documentId property that specifies the document on which to place the tab.
  • envelope_id (String.t): The envelope's GUID. Example: 93be49ab-xxxx-xxxx-xxxx-f752070d71ec
  • page_number (String.t): The page number being accessed.
  • opts (keyword): Optional parameters

Returns

  • {:ok, nil} on success
  • {:error, Tesla.Env.t} on failure

pages_get_page_image(connection, account_id, document_id, envelope_id, page_number, opts \\ [])

@spec pages_get_page_image(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  String.t(),
  String.t(),
  keyword()
) ::
  {:ok, DocuSign.Model.ErrorDetails.t()}
  | {:ok, String.t()}
  | {:error, Tesla.Env.t()}

Gets a page image from an envelope for display. Returns an image of a page in a document for display.

Parameters

  • connection (DocuSign.Connection): Connection to server
  • account_id (String.t): The external account number (int) or account ID GUID.
  • document_id (String.t): The unique ID of the document within the envelope. Unlike other IDs in the eSignature API, you specify the documentId yourself. Typically the first document has the ID 1, the second document 2, and so on, but you can use any numbering scheme that fits within a 32-bit signed integer (1 through 2147483647). Tab objects have a documentId property that specifies the document on which to place the tab.
  • envelope_id (String.t): The envelope's GUID. Example: 93be49ab-xxxx-xxxx-xxxx-f752070d71ec
  • page_number (String.t): The page number being accessed.
  • opts (keyword): Optional parameters
    • :dpi (String.t): Sets the dots per inch (DPI) for the returned image.
    • :max_height (String.t): Sets the maximum height for the page image in pixels. The DPI is recalculated based on this setting.
    • :max_width (String.t): Sets the maximum width for the page image in pixels. The DPI is recalculated based on this setting.
    • :show_changes (String.t): When true, changes display in the user interface.

Returns

  • {:ok, String.t} on success
  • {:error, Tesla.Env.t} on failure

pages_get_page_images(connection, account_id, document_id, envelope_id, opts \\ [])

@spec pages_get_page_images(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  String.t(),
  keyword()
) ::
  {:ok, DocuSign.Model.ErrorDetails.t()}
  | {:ok, DocuSign.Model.PageImages.t()}
  | {:error, Tesla.Env.t()}

Returns document page images based on input. Returns images of the pages in a document for display based on the parameters that you specify.

Parameters

  • connection (DocuSign.Connection): Connection to server
  • account_id (String.t): The external account number (int) or account ID GUID.
  • document_id (String.t): The unique ID of the document within the envelope. Unlike other IDs in the eSignature API, you specify the documentId yourself. Typically the first document has the ID 1, the second document 2, and so on, but you can use any numbering scheme that fits within a 32-bit signed integer (1 through 2147483647). Tab objects have a documentId property that specifies the document on which to place the tab.
  • envelope_id (String.t): The envelope's GUID. Example: 93be49ab-xxxx-xxxx-xxxx-f752070d71ec
  • opts (keyword): Optional parameters
    • :count (String.t): The maximum number of results to return.
    • :dpi (String.t): The number of dots per inch (DPI) for the resulting images. Valid values are 1-310 DPI. The default value is 94.
    • :max_height (String.t): Sets the maximum height of the returned images in pixels.
    • :max_width (String.t): Sets the maximum width of the returned images in pixels.
    • :nocache (String.t): When true, using cache is disabled and image information is retrieved from a database. True is the default value.
    • :show_changes (String.t): When true, changes display in the user interface.
    • :start_position (String.t): The position within the total result set from which to start returning values. The value thumbnail may be used to return the page image.

Returns

  • {:ok, DocuSign.Model.PageImages.t} on success
  • {:error, Tesla.Env.t} on failure

pages_put_page_image(connection, account_id, document_id, envelope_id, page_number, opts \\ [])

@spec pages_put_page_image(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  String.t(),
  String.t(),
  keyword()
) ::
  {:ok, nil} | {:ok, DocuSign.Model.ErrorDetails.t()} | {:error, Tesla.Env.t()}

Rotates page image from an envelope for display. Rotates page image from an envelope for display. The page image can be rotated to the left or right.

Parameters

  • connection (DocuSign.Connection): Connection to server
  • account_id (String.t): The external account number (int) or account ID GUID.
  • document_id (String.t): The unique ID of the document within the envelope. Unlike other IDs in the eSignature API, you specify the documentId yourself. Typically the first document has the ID 1, the second document 2, and so on, but you can use any numbering scheme that fits within a 32-bit signed integer (1 through 2147483647). Tab objects have a documentId property that specifies the document on which to place the tab.
  • envelope_id (String.t): The envelope's GUID. Example: 93be49ab-xxxx-xxxx-xxxx-f752070d71ec
  • page_number (String.t): The page number being accessed.
  • opts (keyword): Optional parameters
    • :body (PageRequest):

Returns

  • {:ok, nil} on success
  • {:error, Tesla.Env.t} on failure

recipients_get_recipient_initials_image(connection, account_id, envelope_id, recipient_id, opts \\ [])

@spec recipients_get_recipient_initials_image(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  String.t(),
  keyword()
) ::
  {:ok, DocuSign.Model.ErrorDetails.t()}
  | {:ok, String.t()}
  | {:error, Tesla.Env.t()}

Gets the initials image for a user. Retrieves the initials image for the specified recipient.

Parameters

  • connection (DocuSign.Connection): Connection to server
  • account_id (String.t): The external account number (int) or account ID GUID.
  • envelope_id (String.t): The envelope's GUID. Example: 93be49ab-xxxx-xxxx-xxxx-f752070d71ec
  • recipient_id (String.t): A local reference used to map recipients to other objects, such as specific document tabs. A recipientId must be either an integer or a GUID, and the recipientId must be unique within an envelope. For example, many envelopes assign the first recipient a recipientId of 1.
  • opts (keyword): Optional parameters
    • :include_chrome (String.t): Obsolete. The chrome is included in the image if it's present in the envelope.

Returns

  • {:ok, String.t} on success
  • {:error, Tesla.Env.t} on failure

recipients_get_recipient_signature(connection, account_id, envelope_id, recipient_id, opts \\ [])

@spec recipients_get_recipient_signature(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  String.t(),
  keyword()
) ::
  {:ok, DocuSign.Model.ErrorDetails.t()}
  | {:ok, DocuSign.Model.UserSignature.t()}
  | {:error, Tesla.Env.t()}

Gets signature information for a signer or sign-in-person recipient. Retrieves signature information for a signer or sign-in-person recipient.

Parameters

  • connection (DocuSign.Connection): Connection to server
  • account_id (String.t): The external account number (int) or account ID GUID.
  • envelope_id (String.t): The envelope's GUID. Example: 93be49ab-xxxx-xxxx-xxxx-f752070d71ec
  • recipient_id (String.t): A local reference used to map recipients to other objects, such as specific document tabs. A recipientId must be either an integer or a GUID, and the recipientId must be unique within an envelope. For example, many envelopes assign the first recipient a recipientId of 1.
  • opts (keyword): Optional parameters

Returns

  • {:ok, DocuSign.Model.UserSignature.t} on success
  • {:error, Tesla.Env.t} on failure

recipients_get_recipient_signature_image(connection, account_id, envelope_id, recipient_id, opts \\ [])

@spec recipients_get_recipient_signature_image(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  String.t(),
  keyword()
) ::
  {:ok, DocuSign.Model.ErrorDetails.t()}
  | {:ok, String.t()}
  | {:error, Tesla.Env.t()}

Retrieve signature image information for a signer/sign-in-person recipient. Retrieves the specified recipient signature image.

Parameters

  • connection (DocuSign.Connection): Connection to server
  • account_id (String.t): The external account number (int) or account ID GUID.
  • envelope_id (String.t): The envelope's GUID. Example: 93be49ab-xxxx-xxxx-xxxx-f752070d71ec
  • recipient_id (String.t): A local reference used to map recipients to other objects, such as specific document tabs. A recipientId must be either an integer or a GUID, and the recipientId must be unique within an envelope. For example, many envelopes assign the first recipient a recipientId of 1.
  • opts (keyword): Optional parameters
    • :include_chrome (String.t): Obsolete. The chrome is included in the image if it's present in the envelope.

Returns

  • {:ok, String.t} on success
  • {:error, Tesla.Env.t} on failure

recipients_put_recipient_initials_image(connection, account_id, envelope_id, recipient_id, opts \\ [])

@spec recipients_put_recipient_initials_image(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  String.t(),
  keyword()
) ::
  {:ok, nil} | {:ok, DocuSign.Model.ErrorDetails.t()} | {:error, Tesla.Env.t()}

Sets the initials image for an accountless signer. Updates the initials image for a signer that does not have a Docusign account. The supported image formats for this file are: gif, png, jpeg, and bmp. The file size must be less than 200K. For the Authentication/Authorization for this call, the credentials must match the sender of the envelope, the recipient must be an accountless signer or in person signer. The account must have the CanSendEnvelope property set to true and the ExpressSendOnly property in SendingUser structure must be set to false.

Parameters

  • connection (DocuSign.Connection): Connection to server
  • account_id (String.t): The external account number (int) or account ID GUID.
  • envelope_id (String.t): The envelope's GUID. Example: 93be49ab-xxxx-xxxx-xxxx-f752070d71ec
  • recipient_id (String.t): A local reference used to map recipients to other objects, such as specific document tabs. A recipientId must be either an integer or a GUID, and the recipientId must be unique within an envelope. For example, many envelopes assign the first recipient a recipientId of 1.
  • opts (keyword): Optional parameters

Returns

  • {:ok, nil} on success
  • {:error, Tesla.Env.t} on failure

recipients_put_recipient_signature_image(connection, account_id, envelope_id, recipient_id, opts \\ [])

@spec recipients_put_recipient_signature_image(
  Tesla.Env.client(),
  String.t(),
  String.t(),
  String.t(),
  keyword()
) ::
  {:ok, nil} | {:ok, DocuSign.Model.ErrorDetails.t()} | {:error, Tesla.Env.t()}

Sets the signature image for an accountless signer. Updates the signature image for an accountless signer. The supported image formats for this file are: gif, png, jpeg, and bmp. The file size must be less than 200K. For the Authentication/Authorization for this call, the credentials must match the sender of the envelope, the recipient must be an accountless signer or in person signer. The account must have the CanSendEnvelope property set to true and the ExpressSendOnly property in SendingUser structure must be set to false.

Parameters

  • connection (DocuSign.Connection): Connection to server
  • account_id (String.t): The external account number (int) or account ID GUID.
  • envelope_id (String.t): The envelope's GUID. Example: 93be49ab-xxxx-xxxx-xxxx-f752070d71ec
  • recipient_id (String.t): A local reference used to map recipients to other objects, such as specific document tabs. A recipientId must be either an integer or a GUID, and the recipientId must be unique within an envelope. For example, many envelopes assign the first recipient a recipientId of 1.
  • opts (keyword): Optional parameters

Returns

  • {:ok, nil} on success
  • {:error, Tesla.Env.t} on failure