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

eSignature API

Find answers to your Docusign eSignature API questions.

  • 536 Topics
  • 1,141 Replies
536 Topics
R
Newcomer
ribeiroanamrbNewcomer
asked in eSignature API
I am getting the error "errorCode":"TEMPLATE_NOT_PROVIDED","message":"Template was not provided."}"

I'm working with a template and I want to add an attachment to it, but this error is returned. Here's the code:  let document1;   try {    let response = await fetch(anexoFuncionario);     if (!response.ok) throw new Error('Erro ao baixar o arquivo');    let contentType = response.headers.get('content-type');    let fileExtension = 'pdf';     if (contentType.includes('image/png')) fileExtension = 'png';    else if (contentType.includes('image/jpeg')) fileExtension = 'jpg';     let arrayBuffer = await response.arrayBuffer();    let base64FileContent = Buffer.from(arrayBuffer).toString('base64');     document1 = new docusign.Document();    document1.documentBase64 = base64FileContent;    document1.name = 'Anexo do Funcionário';    document1.fileExtension = fileExtension;    document1.documentId = '2';   } catch (error) {    console.error('Erro ao processar o anexo:', error);    return res.status(500).send('Erro ao processar o anexo');  }   let signerFunc1 = docusign.TemplateRole.construc

472
R
Newcomer
D
Newcomer
dgh11Newcomer
asked in eSignature API
I am trying to connect to Docusign through my WebApp and my JWT is failing

I have a web app in PHP and JS for front. I am connecting to Dcusign through the JWT and exchanging it for an access token, but i keep getting this error "Decoding JWT did not workUnexpectedValueException: "kid" invalid, unable to lookup correct key in /html/htdocs/mrt_dgheorghe/vendor/firebase/php-jwt/src/JWT.php:477"The code for JWT looks like this: $payload = [ 'iss' => $clientId, 'sub' => $apiUserId, 'aud' => 'account-d.docusign.com', 'scope' => 'signature impersonation', 'iat' => $now, 'exp' => $now + 3600 // 1 hour expiration ]; $privateKey = file_get_contents($privateKeyFilePath); $jwt = JWT::encode($payload, $privateKey, 'RS256', $keypairID); //kid $publicKey=file_get_contents('publicKey.key'); try{ $decodedJWT=JWT::decode($jwt,$publicKey); print_r($decodedJWT); echo "This is the decoded JWT"; }catch(Exception $e){ echo "Decoding JWT did not work"; print($e);Is the kid the equivale

220
D
Newcomer
R
Newcomer
RukkuNewcomer
asked in eSignature API
Failed to generate a Token : Error while requesting server, received a non successful HTTP code with response Body

When fetching envelope details based on filters using ListStatusChanges, the request contains customField as the account number and folderIds as sentitems, with include = "custom_fields" (to retrieve other custom field values).Before executing this request, we call the token API, but the token creation sometimes returns a non-successful HTTP code, though not all the time.What could be the issue? We are implementing it as mentioned below.var _apiClient = new ApiClient(_baseurl);token = _apiClient.RequestJWTUserToken(_integratorKey, _userID, _baseurl, Encoding.UTF8.GetBytes(PrivateKey), 1, Scopes);TokenGeneratedAt = DateTime.Now;

1933
D
Newcomer
N
New Voice
Nicholas H.New Voice
asked in eSignature API
User Management API - User List Failed Call

Hello, We were getting ready to “Go-Live” with our first DocuSign integration but when we went to start the process, it is showing that we don’t have 20 consecutive Api calls. Upon closer review, it looks like the “GetUsers” endpoint (list | REST API | Docusign) is registering as Failed when it cannot find a user. This doesn’t make sense because it is still a successful call is it not? We are using this to check and see if the user exists before creating the signature request. If they do not exist then we call the user Add API.  Any insights into this? Is there a better approach that I am missing? Or do we just need to get past this initial fail and run multiple more tests to get to 20 consecutive successful calls?

605
J
Newcomer
S
Newcomer
shashankNewcomer
asked in eSignature API
Need help with capturing E-sign completion event using webhooks

Things I have tried so far -Define the connect configuration at the Docusign Admin to list all the events to trigger the webhook. - This approach works but it expects the callback url to be static. But I would require the callback url to be generated specific for the server environment.(dev.test.com/callback-url, stage.test.com/callback-url etc. ) Hence this is not an option for me. Tried to set the envelopeEvents and RecipientEvents in the envelope definition. like below but its not triggering the events on complete/decline of signing.  const envelopeDefinition = new docusign.EnvelopeDefinition(); envelopeDefinition.emailSubject = this.template.emailSubject; envelopeDefinition.documents = this.template.documents; envelopeDefinition.recipients = new docusign.Recipients(); envelopeDefinition.recipients.signers = [signer]; envelopeDefinition.status = 'sent'; let eventNotification = new docusign.EventNotification();

584
S
Newcomer
M
Newcomer
MelanieJohnsonnNewcomer
asked in eSignature API
Dashboards by User

Our users do not appear to have the option to create dashboards. Is this a feature available and if so how do we get them set up so that they can?  Currently they just see the standard contracts dashboard but need widgets added to it, BUT all users do not need to see those widgets.

313
M
Community Moderator
P
New Voice
pcrespoNew Voice
asked in eSignature API
Needs to Sign role receiving notification while Needs to View is still reviewing document

I have a template with three roles and the order I want to keep is:Role 1: Needs to View Role 2: Needs to Sign Role 3: Needs to SignMy ideal workflow consists of the role 1 viewing the document and only after the approval, the envelope is sent to role 2 and 3 for signatures. However, I noticed that as soon as the role 1 opens the envelope, role 2 also receives the notification.How can I prevent role 2 from receiving the envelope notification while the role 1 is still reviewing it? Should I actually set role 1 as Needs to Sign and request the consent via an Approve button? Thanks!

312
P
New Voice
S
Newcomer
swamidscNewcomer
asked in eSignature API
Is there an option to customize the email subject and instruction text to include for an Agency as a specified recipient via the API...

Hello, Is there an option to customize the email subject and instruction text to include for an Agency as a specified recipient via the API.Something like below: "Please fill in your details if you are the signatory for this contract. If you are not, please add the recipient's details who should be signing.Note: If you close this dialogue box without entering any details, you will need to reopen the email to add the assignee's information." Thanks,Swami

292
S
Newcomer
S
Newcomer
sneha1Newcomer
asked in eSignature API
DS-Sender Created Folder need to be fetch

Hi Team, I want to fetch custom folder of all user(DS-Admin and DS-Sender) created under same account.While I am trying to all get folder with List API (/restapi/v2.1/accounts/{accountId}/folders?include=envelope_folders,template_folders,shared_tempalte_folders ) with this I am only getting admin folders. Please provide any solution to fetch list of Folder. Thanks,Sneha

527
T
Docusign Employee
S
Newcomer
SaaSNewcomer
asked in eSignature API
Unexpected Results from /accounts endpoint for billingPeriodEnvelopesAllowed, includedQuantity, and allowedQuantity

Hello. We are hitting the /accounts endpoint to try get a few details about our subscription from the API, and but are receiving unexpected results.We are making a GET call to the /v2.1/accounts/{accountId} endpoint in order to report on billingPeriodEnvelopesAllowed. We are receiving a non-numeric value back, when we are were expecting to get the number of envelopes that are allocated to that account.  We subsequently attempted to make a GET call to the /v2.1/accounts/{accountId}/billing_charges endpoint to verify what was in the includedQuantity  and allowedQuantity values, which also didn’t return the expected result. My questions are:Is there a better definition for what should be returned in those values? Is there a known way to get the number of envelopes allocated to a given Docusign account via the API?

231
S
Docusign Employee
B
Newcomer
bhudsonNewcomer
asked in eSignature API
Sending documents to employs via workflow with Docusign for NetSuite

Our HR team is looking for a solution for getting new employees to sign the necessary documents. Would it be possible to create a workflow in Netsuite that sends a specific set of documents to a given email address for the employee to sign?

130
B
Newcomer
S
Newcomer
sokinlegalNewcomer
asked in eSignature API
Show signing date in signature

We're sending contracts to our clients and want the date to be automatically applied alongside their signature, without requiring a separate date field. How can we achieve this?We explored the ‘Signing Settings’ option in the admin portal but couldn’t find the "Show signing date in signature" option. Could this be related to our subscription plan, or can it be enabled by requesting support?

452
M
Community Moderator
N
Newcomer
nomanNewcomer
asked in eSignature API
how to redirect after user signed the document received through email, to one of my application page?

I have created document through rendering dynamic html content, and then converting into pdf through pdfkit library and sending though Api , after receiving  document on email  to review, and signing the document, I want to redirect to one of my application page, currently it is showing docusign signup page, but i want to redirect to my application page .I have somewhere read about redirectUrl concept, can anyone let me know full process for this.If any one can go through process to let me understand 

10603
S
Newcomer
C
Newcomer
CPaparoniGlasNewcomer
asked in eSignature API
Composite Templates - merge multiple server templates into single PDF

I’m looking into the possibility of merging together two (or more) server templates into a single PDF; currently I’m creating envelopes through Python and using Composite Templates. The envelope structure I have so far makes it so that each Composite Template results in a single PDF; each Composite Template has its own Server Template and/or Inline Template, depending on the specific template I need to use -- now, what I need (but isn’t working) is something like this (taken from another post): { "emailSubject": "DocuSign Widget Order, Signature and NDA", "emailBlurb": "Please let us know if you have any questions.", "status": "sent", "compositeTemplates": [ { "serverTemplates": [ { "sequence": "1", "templateId": "{{NDA Template}}" }, { "sequence": "2", "templateId": "{{Signature Template}}" } <-- this used to be a separate Composite Template object ], "inlineTemplates": [ { "sequen

463
Michael.Rave
Docusign Employee
neethujkp
Troubleshooter
neethujkpTroubleshooter
asked in eSignature API
Is Salesforce Connector Required for using Extension App

I am referring to the IAM Core - Professional Edition plan.In our case, we intend to use the Salesforce Extension App along with Maestro. Do we need to purchase the DocuSign Salesforce Connector add-on ?

382
M
Community Moderator
K
Newcomer
Katie BNewcomer
asked in eSignature API
Can anyone help with a docusign hubspot integration error around custom fields

A former employee created a custom field integration to add the start date to a docusign agreement. I updated the Hubspot property to ACC Cohort Start date. It was previously just ACC Start date, and now nothing works. This is the connection on the Hubspot end:  This is the connection on the Docusign end:This is what the agreement form looks like in docusign:This is what the agreement form looks like when it’s assigned in Hubspot: Can anyone tell me what error I’ve made?

322
K
Newcomer
D
Newcomer
danifromtechNewcomer
asked in eSignature API
Implementing "Checkbox as Electronic Signature" in Webflow Form with DocuSign Integration

My SetupI have a user access request form built in Webflow that requires users to agree to terms and conditions. Currently, the form has a checkbox that users must check to indicate agreement.What I'm Trying to AccomplishI want to implement a legally binding electronic signature process where:The user simply checks a box to sign the terms and conditions This checkbox action is recorded as a valid electronic signature in DocuSign The signature is legally binding and creates proper audit records The entire process happens within my Webflow form without redirecting to DocuSignTechnical RequirementsThe form needs to maintain its current UX with checkbox-based acceptance Each signature needs to be properly recorded and verifiable Solution should work with Webflow's capabilities Must capture relevant metadata (timestamp, IP address, etc.) for legal validity (optional tbh)Specific QuestionsIs it possible to use DocuSign's API to record a checkbox click as an electronic signature? Can DocuSign

582
A
Docusign Employee
H
Newcomer
harikiranNewcomer
asked in eSignature API
Error: There was a problem opening the document. Please contact your administrator.

Hi Community,I have followed all the exact steps and configured docusign.I have provided all the table permissions, and all looks good except one error when I click on View and Sign button which is as attached. Error: “There was a problem opening the document. Please contact your administrator.” Please let me know what exactly is causing this issue and how can I resolve the issue.   

432
Ivan.Dinkov
Docusign Employee
N
New Voice
nitish555New Voice
asked in eSignature API
Composite template: Adding a recipient in a conditional recipient group

I have been successfully using a composite template to add recipients to a server template.(see attached code) However, one of the recipients - Approver at routing order 3 is now a part of a conditional recipient group. (See attached image) When I now try to overwrite the recipient at routing order 3, i end up with two recipients at routing order 3 instead of one. (See attached image) I tried a workaround where I would simply update the recipient at routing order 3 using PUT method of the recipients endpoint in the REST api, however that did not work either.  How can I overwrite the recipient in the conditional routing group at routing order 3 using a composite template?  { "emailSubject": "@{variables('SubjectLine')"}, "status": "sent", "compositeTemplates": [ { "serverTemplates": [ { "sequence": "1", "templateId": "@{items('For_each')?['hrsys_docusigntemplateid']"} } ], "inlineTemplates": [ { "sequence": "2",

906
M
Community Moderator
F
Newcomer
FrancisTVoobanNewcomer
asked in eSignature API
Configuring OAuth 2.0 for EventNotifications

Hi there!We currently are working toward adding a DocuSign integration into our App. Our workflow is quite simple and was implemented without issue into our Continuous environment using the eSignature API to create envelopes and Connect to listen to events happening to those envelopes. We use an OAuth2.0 Client to be able to authorize DocuSign to call our backend using a route listening to Connect calls and act on those events. Now that the implementation on Continuous has been successful we would like to implement it on other environments including our Test environment. Every environment use a different base url and a different OAuth client. In order to setup that we looked into the EventNotificaiton property of the envelope to be able to configure a custom url to send our events for that specific envelope. I’m still stuck on one last point, I need to be able to specify the OAuth2.0 configuration to use for that EventNotification. Is there a way to specify it? Thank you.

693
M
Community Moderator
J
Newcomer
jgarciaNewcomer
asked in eSignature API
Create Rule through the API

Hello, I am creating a form that requires to activate some fields, I know it is possible to achieve it with the rules. Is it possible to create a rule through the API?. Thanks.

150
J
Newcomer
N
Newcomer
NishantNewcomer
asked in eSignature API
API textTabs not populating

 Hi EveryoneI am new to DocuSign and currently integrating it with MuleSoft using the "Envelopes Post Envelopes" API. I am sending the following payload, but the envelope is not being populated with the data I am passing. However, when I include xPosition and yPosition, the data appears in the envelope. My goal is to populate the fields using tabLabel instead, but it is not working. How can I resolve this issue?Template with Standard Text field Payload:{ "brandId": "d380fe66-xxxxxxxxxxxxx", "templateId": "63ebae68-xxxxxxxxxxxxxxxxxxxx", // Need full template ID "status": "sent", "compositeTemplates": [ { "templateId": "63ebae68-xxxxxxxxxxxxxxxxx", // Should match above "sequence": "1", "inlineTemplates": [ { "sequence": "1", "recipients": { "signers": [ { "roleName": "Signer1", // Match template

521
I
Docusign Employee
A
Newcomer
ARathoreNewcomer
asked in eSignature API
PhoneAuthentication is null while getting the Recipients from Docusign package using Docusign .net PKG while it is present in package at account.

 PhoneAuthentication is received as null.Code used to add Authentication is below: orignalSigners.IdCheckConfigurationName = "Phone Auth $";                                    RecipientPhoneAuthentication recipientPhoneAuthentication = new RecipientPhoneAuthentication();                                    List<string> senderProvidedNumbers = new List<string>();                                    recipientPhoneAuthentication.SenderProvidedNumbers = senderProvidedNumbers;                                    recipientPhoneAuthentication.SenderProvidedNumbers.Add(t.PhoneNumber);                                    orignalSigners.PhoneAuthentication = recipientPhoneAuthentication; Trying to get Signer with Authentication using following code but the signer.PhoneAuthentication is received as null: System.Net.ServicePointManager.SecurityProtocol = (System.Net.SecurityProtocolType)3072;                accountID = this.GetAccountID();                EnvelopesApi envelopesApi = new Env

221
M
Docusign Employee
A
Newcomer
arjunkishorkumar.govaniNewcomer
asked in eSignature API
Regarding AutoSign flow

Hi Team,Actually we are using “#Automatically send to eSign”  flow in DocuSign. Previously it used to work but recently flow got broken and we are getting response as Draft from Docusign and not sending for Signature automatically even though we are providing anchor signature details in request body.Can you please let us know what might be the issue ?Thanks in anticipation!Regards,Bhaskari.

221
I
Docusign Employee
A
Newcomer
AndréCunhaCarvalhoNewcomer
asked in eSignature API
Handling SMTP errors in AutoRespondedReason field with C#

Is there a way to translate the message in the AutoRespondedReason field when receiving a Connect callback or when calling the List Recipients API?I see no pattern in the text I receive from this field, sometimes it comes with the STMP error code, and sometimes it doesn’t, and I can’t show this message to the user of my system, because it is not easy to understand the real error that occurs.My APIs are in C#, it would be great if DocuSign could translate the error or give us a way to decode it.

151
karan.kaushik
Docusign Employee

Badge winners

  • 1st Reply Posted
    voconnor28has earned the badge 1st Reply Posted
  • 1st Question Posted
    SDBDMhas earned the badge 1st Question Posted
  • 1st Question Posted
    d25wordshas earned the badge 1st Question Posted
  • 1st Reply Posted
    astra2025has earned the badge 1st Reply Posted
  • 1st Reply Posted
    ivanhorvathas earned the badge 1st Reply Posted
Show All Badges
Code of Conduct

Docusign Community

Code of Conduct