Skip to main content
arrow-left Back to Docusign.com

eSignature API

Find answers to your Docusign eSignature API questions.

  • 453 Topics
  • 988 Replies
453 Topics
T
Newcomer
tijnNewcomer
asked in eSignature API
How to recognize a delivery failure through the REST API?

Hi, One of my documents failed to deliver because of an incorrect e-mail address But all the API response lists is that the envelope has status “sent”: { "resultSetSize": "3", "startPosition": "0", "endPosition": "2", "totalSetSize": "3", "nextUri": "", "previousUri": "", "envelopes": [ { "status": "sent", "...": "..." }, {...} ]} I would like to recognize an issue like this so I can report it in the module we’ve been building, but have been unable to do so with “listStatusChanges” or “Envelopes:Get”. Is it not the status?Am I missing some other field?Do I need a different request?

752
T
Newcomer
Y
Newcomer
YefanNewcomer
asked in eSignature API
I have an issue by sending a draft envelope with DocuSign API

Hello, I’d like to send a draft envelope via DocuSign API. The application uses ASP.NET Core. What I’ve done so far, I retrieved the envelope with GetEnvelope and set Status as “sent”, then I called Update method to change the envelope status. The envelope contains one Document, and 2 Recipients. And I received an error as follows : Error calling Update: {"errorCode":"INVALID_REQUEST_PARAMETER","message":"The request contained at least one invalid parameter. Value for 'purgeState' must be 'documents_queued' or 'documents_and_metadata_queued' or 'documents_dequeued' or 'documents_and_metadata_and_redact_queued'."} I tried to set PurgeState as “documents_dequeued” (1) or “documents_queued” (2) but I received different error messages : (1) documents not in the purge queue, and (2) the envelope must be completed first, which is not the case. I just want to send the draft envelope with documents to sign after storing the envelope id in our database, so I can keep track of the envelope statu

811
Y
Newcomer
N
Newcomer
narendra-nandaniyaNewcomer
asked in eSignature API
Unexpected API Behavior

Hello DocuSign Community, I am using the DocuSign Monitor API in my developer account and have noticed an unusual behavior in the API responses. Specifically, records with the data field having attributes such as IDs, IPs, or user agents are returned as a list of individual characters rather than as a single string. For example, instead of: "userId": "abab12" the API response gives: "userId": ["a", "b", "a", "b", "1", "2"] This behavior is not consistent across all records and only occurs in certain records. Is this the intended behavior of the API, or could it be a potential bug? Note: I have observed this behavior at least for ‘Alert’ records related to ‘Envelope’ activities. I have attached a screenshot for reference. Docusign Monitr API response

491
Ivan.Dinkov
Docusign Employee
S
New Voice
singhanubhavNew Voice
asked in eSignature API
Go live Docusign app

Once i submit the docusign application for “Review”, review gets passed and status c, when i hit “Go live” then the docusign team would manually review my application or how does the go live process works, please explain & how many days it takes!!

696
T
Newcomer
N
Newcomer
nhugg12Newcomer
asked in eSignature API
AUTHORIZATION_INVALID_TOKEN on envelopesApi.CreateEnvelope

Morning, Hoping someone can help me out. I’m currently getting the below response when making the call “envelopesApi.CreateEnvelope(accountId, envDef)”:{"Error calling CreateEnvelope: {""errorCode"":""AUTHORIZATION_INVALID_TOKEN"",""message"":""The access token provided is expired, revoked or malformed. Authentication for System Application failed.""}"} I’m providing a valid access token to the call, and had previously had this working when using the link https://developers.docusign.com/token-generator/ to generate the Token for me while testing. When moving to automatically generate the token, the token provided is no longer working. Please see my code below for the whole process, I’m storing the the details in an object to access them, if these details are required please let me know: Private Sub SendToDocuSign(firstName As String, lastName As String, email As String, body As String, docsignAttachment As String) Dim baseUri As String = String.Format(oSetting.APITokenURL) Dim codeAuth

511
J
Docusign Employee
V
Newcomer
vishnuNewcomer
asked in eSignature API
how to disable envelope id stamping in document

How do you disable envelope ID stamping in the document? I have set Envelope id stamping to false, yet it is still not disabled.

825
C
Community Moderator
M
New Voice
mehul.shahNew Voice
asked in eSignature API
Embed image / recipient's signature in document

Hello, We’ve a couple of requirements listed below - To generate a document which needs to have an image embedded on the document. Image is stored inside Salesforce. To generate a document which needs to have an image embedded on the document. Image is the signature of a recipient which has previously signed another document which has similar or almost same information as the new one. I can see that this API - getRecipientSignature | REST API | Docusign - can fetch the user signature. But imageBase64 attribute is not returned in the response. I observed that the signatureType attribute is “rubberStamp” in the response. How to achieve this ? Should I use eSignature API ? If yes, how to get the base64 for recipient’s signature ? Should I use DocGen API ? Note: I don’t want to send an envelope for signing. Appreciate the help. Thanks in advance!

372
M
New Voice
N
Newcomer
najithNewcomer
asked in eSignature API
Docusign autoplace make.com

I am trying to create a make.com automation where the file is taken from a folder and is send out as a document using docusign module. I have issues with autoplacing text box fields. I have entered anchor string for each of the fields that needs to be filled but ther autoplace text box does not work. All I am able to do is set up positions for signature. I cannot find any resource to do this. Do I need to get a paid account to perform this task?

481
I
Docusign Employee
R
Newcomer
Roshan DevNewcomer
asked in eSignature API
Checkbox Group not working properly

I have three check box and mapping max and minimum required value, but finally user to select all checkbox. After submitting the document, the checkbox displayed an 'X' mark." we need "tick" mark. pls refer the below code. Checkbox checkbox1 = new Checkbox { TabLabel = "LionTab", DocumentId = "1", PageNumber = "1", RecipientId = "1", XPosition = "200", YPosition = "300", TabGroupLabels = new List<string>{ "checkboxgroup1"} }; Checkbox checkbox2 = new Checkbox { TabLabel = "TigerTab", DocumentId = "1", PageNumber = "1", RecipientId = "1", XPosition = "220", YPosition = "300", TabGroupLabels = new List<string>{ "checkboxgroup1"} }; Checkbox checkbox3 = new Checkbox { TabLabel = "BearTab", DocumentId = "1", PageNumber = "1", RecipientId = "1", XPosition = "240", YPosition = "300", TabGroupLabels = new List<string>{ "checkboxgroup1"} }; TabGroup checkboxTabGroup = new TabGroup { GroupLabel = "checkboxgroup1", ValidationMessage = "Please check a box", GroupRule = "SelectExactly", MinimumReq

441
M
Docusign Employee
D
Newcomer
Danilo João de SousaNewcomer
asked in eSignature API
Request token

Hello, I am executing the endpoint https://account-d.docusign.com/oauth/auth?response_type=code&scope=signature%20impersonation&client_id=5a4a5c68-492f-4edc-a66c-ef2f88b17af8&redirect_uri=http://localhost, which returns an encoded code. However, when I input this code into the JWT site, it fails to decode the PAYLOAD section. I use this code to add to the assertion and use the link https://account-d.docusign.com/oauth/token to request the token, but it is unsuccessful, resulting in the following error: { "error": "invalid_grant", "error_description": "user_not_found" } I would like to know how I can resolve this situation.

440
D
Newcomer
K
Newcomer
Kathleen.HNewcomer
asked in eSignature API
Checkbox Tab Group

I’m attempting to make one of two checkboxes required. This is my json: "checkboxTabs": [ { "anchorIgnoreIfNotPresent": "true", "anchorString": "InsurerRequired_CKYes", "anchorUnits": "pixels", "anchorXOffset": "0", "anchorYOffset": "0", "tabId": "InsurerRequired_CKYes", "tabLabel": "Insurer Required", "tabGroupLabels": [ "checkboxgroup1" ] }, { "anchorIgnoreIfNotPresent": "true", "anchorString": "InsurerRequired_CKNo", "anchorUnits": "pixels", "anchorXOffset": "0", "anchorYOffset": "0", "tabId": "InsurerRequired_CKNo", "tabLabel": "Insurer Not Required", "tabGroupLabels": [ "checkboxgroup1" ] } ], "tabGroups": [ { "groupLabel": "checkboxgroup1", "minimumRequired": "1", "maximumAllowed": "1", "tabType": "tabgroup" } ] The behavior is not changing with the tabGroups definition. Both checkboxes are still optional, and both checkboxes can be selected. I would appreciate any insight! I did attempt to create radio buttons, but I got a runtime error.

4433
L
Newcomer
R
Newcomer
Roshan DevNewcomer
asked in eSignature API
User can edit and sign the document

i send document to user via api. user can edit the checkbox before the signature, Here added signhere details in tab. pls share any suggestion for edit the checkbox or how to enable particular page for Edit. Regards, Roshan

333
B
Docusign Employee
M
Newcomer
mhnamadrNewcomer
asked in eSignature API
MaxLength Limit for Email Address

We are using the docusign API to create an envelope. Our system uses a 254 character maximum for email length (per the limit specifeid by the IETF). We are receving ther following exception from the CreateEnvelope function of the docusign API: “Cannot set column ‘Email’. The value violates the MaxLength limit of this column.” Is there anyway to increase the MaxLength limit for email address?

671
T
Docusign Employee
B
Newcomer
babaiahNewcomer
asked in eSignature API
Need to use enable existing pdf fields

can we use existing checkboxes of pdf document to enable the fields while doing docusign in docusign editor using c# with out adding any additional fields on pdf form like signhere tabs. It should not add any new fields on the pdf existing fields position. Please help me on this, we are trying to enable the existing pdf fields to edit the form when the user is signing the form using docusign editor. Please find the screenshot.

703
karan.kaushik
Docusign Employee
V
Newcomer
Valentina StricklerNewcomer
asked in eSignature API
Error when connecting an integration Api

I created a new APP in my DocuSign Developer account. When I try to connect it to my website I get the following error message:Error while requesting server, received a non successful HTTP code with response Body: {“error”: “invalid_grant”, “error_description”: “issuer_not_found”} For the type of connection I am needing I had to generate code grant I used the Private Code Grant, I followed the detailed step by step with the help of the video and then I gave consent to the user. But anyway I still get the error. I had already generated this connection with other apps and it worked successfully. Can you help me please?

2103
karan.kaushik
Docusign Employee
P
Newcomer
pat000Newcomer
asked in eSignature API
restricting fields when editing document

Hi, We’re trying to build a simple integration in our web app with DocuSign, where users will upload an ad-hoc document, then use drag & drop interface to add fields such as Signature, Name, Date Signed. We’re embedding sender view URL for the envelope in an IFRAME (see below). Is there a way of restricting/specifying which fields the user is able to drag from the palette? We’ve been playing with various TaggerSettings, but without any luck.

201
K
Docusign Employee
I
Newcomer
ItequiaNewcomer
asked in eSignature API
Read custom fields data from API

Hi, We want to automate the creation of documents and their sending for signature. I suppose it is possible to create documents from templates created in Docusign using an API, to which we pass the particular data of each case. My question is about the custom fields that we can configure with the signature (checkboxes, texts, dates...). Is it possible to read the information or status of these custom fields from the API? To save the data in our system. Thanks.

1192
I
Newcomer
D
Newcomer
Denny.TongNewcomer
asked in eSignature API
Getting the error message "The specified envelope has duplicate recipients." when sending 2 or more documents with the same template format.

Good Day, I’m using the RESTAPI to send documents from an in-house developed system to DocuSign to be sent out to recipients. The setup is as follows: Roles have been setup as signatory 1, signatory 2, signatory 3, etc The documents to be sent have the same format but with different, names, titles, etc. example: document1 is meant for signatory 1, document2 is meant for signatory 2, document3 is meant for signatory 3, etc Each of these documents also has signing fields for Director 1 and Director 2. The documents are included for matching. On DocuSign, I’ve created individual templates for each of the documents. example: there is a template for document1, a template for document 2, a template for document 3, etc When sending the documents for signing individually from the in-house developed system, it is successful. example: sending document 1 goes to recipient with the role signatory 1, and Director 1 and Director 2. The same goes for document 2 and document 3. However, if sending the

2922
D
Newcomer
A
New Voice
Avinash WaghNew Voice
asked in eSignature API
How to get recipient signature image and consume it?

@All Community Care i’m trying to download the recipient signature image.how to use it because i’m receiving the format like "GIF89aA\u0002�\u0000�\u0000\u0000\u0000\u0000\u0000\u0000\u00003\u0000\u0000f\u0000 ...” how to consume on frontend to show image ?

16310
M
New Voice
K
Newcomer
kamranrafiNewcomer
asked in eSignature API
Envelop creation

I have setup docusign API, Every thing is working fine . I can create envelop and can see the envelop id in response but signer is not receiving any emails to sign the documents.

311
B
Docusign Employee
M
Newcomer
MairingdaoNewcomer
asked in eSignature API
How to change an envelope recipient without losing the already filled fields ?

How do I change an Envelope’s recipient without losing the tab values that may already have been filled by the previous user using esign api ? Few things I have found and triedcollaborative fields are persisted over recipient updates update recipient removes the fields that were filled by the previous recipient (using Finish Later option) If update follows the following steps1. mark all fields for recipient as shared: true using updateRecipientTabs api 2 update recipient 3 reset changes done in step 1 This works but it looks like a lot of over complication.

142
M
Newcomer
Tommie.Huynh
Docusign Employee
Tommie.HuynhDocusign Employee
posted in eSignature API
Research Opportunity for Docusign Developers

Hi everyone! My name is Tommie Huynh and I am a User Experience Researcher here at Docusign. Our team is currently conducting a research study to improve our product, and we need your valuable insights. We are looking for Docusign Developers who have past experience leveraging our APIs to build integrations. We’d love to hear your thoughts and experiences to help shape the future of our developer tools - here are the details: What’s Involved: Session Dates: November 11th-14th Format: 1-hour 1:1 Zoom session Focus: Integration Key (Client ID) Management Compensation: $150 gift card or donation to your choice of charity If you’re interested in participating, please fill out this brief survey to help us understand if you’re a good fit: https://docusign.co1.qualtrics.com/jfe/form/SV_bkddwRMddgZuTFc. We’ll review your responses and reach out to you if you match the criteria for the study. Your voice is crucial in helping us improve the Docusign developer experience, and we truly appreciate

360
Tommie.Huynh
Docusign Employee
A
Newcomer
amy.RedCrossNewcomer
asked in eSignature API
Where to find Running User?

As a DocuSign Admin, I'm trying to update the API Username (running user) for our Salesforce integration. Previously, my work email was set as the running user, which we want to change to a dedicated service account email. However, the DocuSign interface has been updated, and I can't locate this setting anymore. Can someone guide me to where I can find and update the API Username or running user for our Salesforce integration in the current DocuSign admin interface?

292
A
Newcomer
R
Newcomer
RamonHolandaNewcomer
asked in eSignature API
Chinese letters do not work correctly

Hello experts, I'm facing a problem with Docusign when sending an envelope via API basically when I get to the email to sign it, some Chinese letters don't appear properly, but when I convert the base64 sent to PDF, they appear correctly. Has anyone faced something similar? Could you help me with the solution? error: ok:

331
Hengfeng Ge
Rising Star
J
Newcomer
Jean_suiteopNewcomer
asked in eSignature API
Envelope update

I want to be able to update email of an envelope and resend in case where invalid or wrong email is inputted by the user.I am using this endpoint:(PUT) [base_path]/restapi/v2.1/accounts/[accountId]/envelopes/[envelopeId]/recipients?resend_envelope=true And this parameter: { "signers": [ { "email": "<email>", "name": "<full_name>", "roleName": "<roleName>", "recipientId": "<recipientId>" } ]} After sending it, the email is modified and they receive the document to sign, but the position to sign disappears, how do i rectify this, i want the updated envelope to come with the signer tab. Also when i change the email from an existing email that was sent to the document, the older email still has access to the document, i also want their access to be nullified. Thanks

531
B
Docusign Employee

Most helpful members this week

Badge winners

  • 1st Reply Posted
    ELHhas earned the badge 1st Reply Posted
  • 1st Reply Posted
    Zeke95has earned the badge 1st Reply Posted
  • 1st Question Posted
    EssentialFundinghas earned the badge 1st Question Posted
  • 1st Question Posted
    Zeke95has earned the badge 1st Question Posted
  • 1st Reply Posted
    JamjarPWhas earned the badge 1st Reply Posted
Show All Badges

Popular tags

Code of Conduct

Docusign Community

Code of Conduct