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

eSignature API

Find answers to your Docusign eSignature API questions.

  • 447 Topics
  • 978 Replies
447 Topics
A
New Voice
Avinash WaghNew Voice
asked in eSignature API
Can we user esign without document from the integrated service?

my app have form with signature field box where he will click for sign with docusign and he should get the ui of the select sign and submit and in response he will get the signature. because form is not yet submitted we cant sent the document to docusign.is ti possible to use the esign as only the signature service ?

543
K
Docusign Employee
M
New Voice
MichailoNew Voice
asked in eSignature API
IDR Zone creation with API

HiIs it possible to create and update IDR Zones with? ‘machboxes’ array is returned in GET documents response, but when I try to use PUT for documents with such object it does not work BR

371
Leandro.Reis
Docusign Employee
S
Newcomer
stellarNewcomer
asked in eSignature API
Populate standard fields (or prefilled fields) set in template with data from my database before sending out the envelopes to any of the recipients with the sdk or api

My use case is simple: I have a template where I’ve placed multiple text fields with unique data labels to later be populated. (I’ve also tried using pre-fill text fields) The data for it comes from my database. I am using the nodejs sdk (i.e. docusign-esign npm package). I found the docs extremely confusing and I just haven’t been able to generate envelopes with the populated data from my database. I have created this helper function to send envelopes: import { EnvelopesApi, type EnvelopeDefinition } from 'docusign-esign'; export const sendEnvelope = async ({ envelope }: { envelope: EnvelopeDefinition }) => { const dsApiClient = await createClient(); // createClient returns the docusign.ApiClient which I have removed in this post for maintaining simplicity const envelopesApi = new EnvelopesApi(dsApiClient); const { envelopeId } = await envelopesApi.createEnvelope(process.env.ACCOUNT_ID, { envelopeDefinition: envelope });} And now I am trying to populate these fields: The data labels a

4811
Ivan.Dinkov
Docusign Employee
K
Newcomer
kevin huangNewcomer
asked in eSignature API
How to assign Template's Custom Field via API before sending a contract?

Dear, when I request a signature by email using a template by below API link 1, I found it doesn’t meation how to assign value to Custom Field in template. So I search info in docusign community as below Website link 2, but I can’t get Custom Field in my test template using below API link 3. It only rely 4 inexistence Custom Field in template as below shortcut_1 show. But it should rely custom field as below shortcut_2 show. API link 1: https://developers.docusign.com/docs/esign-rest-api/how-to/request-signature-template-remote/ Website link 2: API link 3: https://developers.docusign.com/docs/esign-rest-api/reference/templates/templatecustomfields/list/ shortcut 1: shorcut 2:

1801
Ivan.Dinkov
Docusign Employee
P
Newcomer
psarnpanichNewcomer
asked in eSignature API
Does Agreement Action Rule or eSignature API need to pay extra service ?

May I know below 2 methods. Which one need to pay for extra service or free to use ? Agreement Action Rule / Agreement Connection to MS Shared Point / One Drive / Drop Box Using eSignature API with Apps and Integration Keys – to download document The idea what we want to achieve is to sending finished document to keep on other file server location.

311
Michael.Rave
Docusign Employee
I
Newcomer
imahmad4allNewcomer
asked in eSignature API
AUTHORIZATION_INVALID_TOKEN, The access token provided is expired, revoked or malformed. Authentication for System Application failed.

I am trying to integrate DocuSign using ABAP, I am able to generate access token, with the generated access I am trying to access below API: 'https://demo.docusign.net/restapi/v2.1/accounts/' lv_account_id '/envelopes' the above API is called immediately after the generated access token, I am not sure why I am getting error message, I have to complete the POC ASAP since we are planning for go-live by month end if everything goes good. Kindly help.

7182
I
Newcomer
M
Newcomer
MrMarkJacksonNewcomer
asked in eSignature API
REST API - Creating envelope with no content

Hello, I've been tasked to build an interface with docuSign. However, my company is using ColdFusion and there isn't a whole lot of references out there for doing this. My goal right now is to send a pdf from a local drive to docuSign and have a user sign a specified location. This is my dev code so far, running this creates an envelope, but no document or recipients are attached to the envelope it creates. Any help would be appreciated.

611
M
Newcomer
D
Newcomer
DamanNewcomer
asked in eSignature API
JWT Authentication returning error while matching code examples

I’ve downloaded the DocuSign NuGet package, and also the code examples provided by DocuSign through the quick start for comparing. I have matched my code to the code examples downloaded within my own project. Confirmed my UserId/ImpersonationId, IntegrationKey/ClientId match from what the code examples use to what my login “Apps & Keys” have. After attempting to call the “AuthenticateWithJwt(string api, string clientId, string impersonatedUserId, string authServer, byte[] privateKeyBytes)” I get an ApiException of “Error while requesting server, received a non successful HTTP code with response Body: ” I’ve followed through the documentation on https://developers.docusign.com/platform/auth/jwt/jwt-get-token/ When using POSTMAN I’m able to get an access token. However, so far I’ve been unsuccessful in getting the DocuSign NuGet package code to work. I’ve tried searching around the forums for any reference to the error response I’m getting with no success. Any help in pointing me in the

3394
D
Newcomer
X
Newcomer
xiamanyuNewcomer
asked in eSignature API
USER_NOT_ENVELOPE_SENDER_OR_RECIPIENT when download document or revoke a envelope

We have integrated with DocuSign(Java SDK). When downloading signed documents and revoking envelope, most processes are successful, but a few report this error. What could be the reason? { "errorCode": "USER_NOT_ENVELOPE_SENDER_OR_RECIPIENT", "message": "This user is not the sender or a recipient of the envelope. Only the sender or a recipient of the envelope may perform the requested operation." }

1871
K
Docusign Employee
A
Newcomer
atr_crmNewcomer
asked in eSignature API
support for multiple signers on multiple (but fewer) signature blocks

I have a document that can be signed by (any) 2 out of 5 possible signers (signers A, B, C, D, E for example.) What i envision is a document with 2 signature blocks that once signer B signs the first block, the second block is only signable by one of signers A, C, D or E) Once that second signature is obtained (from A, C, D or E) the document should be completed. How do I build this envelope? I am actually building and creating envelopes using teh API and not interactively. Note: we already have this working when we have 5 signers but only one is required to sign so we don’t need a solution for that. atr

3145
C
Newcomer
M
New Voice
MichailoNew Voice
asked in eSignature API
Transfer template to different user with API

Is there any way to change owner of template with API? Share scenario is not enough as the new owner should be able to edit the template, not only use it. I would like to avoid impersonation with jwt as in my scenario there is no org domain configured, so it’s impossible for me. BR Michailo

542
M
New Voice
E
Newcomer
EthanNewcomer
asked in eSignature API
Envelope attachments - confusing documentation and unexpected behavior

The schema for the envelope creation endpoint allows the addition of an envelope attachment. However, adding one at envelope creation time does not work. The envelope is created, but the attachment is not (as confirmed by querying the API for envelope attachments with the envelope ID). If I first create the envelope, then add the attachment with the exact same attachment properties, the attachment gets created as expected. Is this a bug? If not, why put envelope attachments in the envelope creation request schema? Also, some of the fields are very confusing in their behavior and in their descriptions in the documentation. I’m hoping someone may have some insight to a few of them. AttachmentId - If an attachmentId is provided to create the attachment via the envelope attachments create endpoint, a different, unique ID is returned when querying for it. Why give the ability to provide an ID if it changes regardless of what’s provided? Label - What does this field actually do? The document

532
Kevin.Ponseel
Docusign Employee
O
Newcomer
optim developerNewcomer
asked in eSignature API
How to obtain all completed envelopes with a single API call

I am attempting to obtain all completed envelopes (received, sent, deleted (disappeared from the trash Folder), and shared) that a currently logged-in user has access to, by calling the liststatuschanges API. However, when specifying the following minimum set of parameters, only envelopes that the logged-in user has created are returned with CC'ed files, files received upon signature request, etc. missing. status=completed&include=documents,folders&from_date=2024-01-01 When folder_types=normal,inbox,sentitems was included, I was able to confirm the return of sent and received files, however, deleted files (disappeared from the trash Folder) and shared files were not returned. Is there a way to obtain all files, including deleted files, that a presently logged-in user has access to, in a single API call?

2384
O
Newcomer
S
Newcomer
StevenFNewcomer
asked in eSignature API
How to create a GET request for Zapier purposes

I need to create a GET Request to get the status of a sent document. Can someone help me without to set this up?

1474
H
Newcomer
R
Newcomer
RonakBansalNewcomer
asked in eSignature API
Issue with Collaborative fields

I have two recipients defined - R1 and R2I have a text tab “Last Name” on the docusign form and it is set up as Collaborative. When I hit the restAPI /accountId/envelopes, and send the nodes as below - The R1 user cannot view the field value: { "status":"sent", "templateId":"<ID>", "templateRoles":[ { "roleName":"R1", "email":"email@email.com", "name":"name", "tabs":{ "textTabs":[ { "tabLabel":"patient.email", "value":"test@test.com", "shared":"true" } ]}}]} But when I send the envelope to both the recipients R1 and R2, then it works fine. Both of them can view and edit the field value { "status":"sent", "templateId":"<ID>", "templateRoles":[ { "roleName":"R1", "email":"email@email.com", "name":"name", "tabs":{ "textTabs":[ { "tabLabel":"patient.email", "value":"test@test.com", "shared":"true" } ]}}, { "roleName":"R2", "email":"email@email.com", "name":"name", "tabs":{ "textTabs":[ { "tabLabel":"patient.email", "value":"test@test.com", "shared":"true" } ]}}]} Please help on how to achi

1816
M
Newcomer
JohnSantos
Valued Contributor
JohnSantosValued Contributor
asked in eSignature API
Purging documents POSTMAN Help

I’m testing the API call to add an envelope to be purged. I have a completed envelope ID from one of our Dev environment. I’ve been able to successfully change the purgeState from “documents_and_metadata_and_redact_queued” to “documents_dequeued” using the API Explorer from developers.docusign.com When I try the same API call from Postman, I’m getting the following error: "errorCode": "DOCUMENT_PURGE_FAILED", "message": "Error adding documents to the purge queue. Only the sender may remove the envelope documents" I can make other successful calls using Postman. I’m the same user; that sent the envelope. Any idea what the issue is in Postman?

241
JohnSantos
Valued Contributor
A
Newcomer
arthur.santosNewcomer
asked in eSignature API
Ancoragem assinaturas

Estou tentando implementar a parte de ancoragem das assinaturas no documento, porem, ao subir o envelope ele ignora as posições enviadas. Podem me auxiliar. Payload: { "documentos": [ { "documentBase64": "BASE64", "documentId": "188777", "fileExtension": "doc", "name": "PRESTAÇÃO DE SERVIÇOS.doc" } ], "emailSubject": "Assinatura de Documentos", "destinatários": { "signatários": [ { "e-mail": "arthur.santos@elaw.com.br", "nome": "Artur Santos", "recipientId": "58883", "routingOrdem": "1", "guias": { "initialHereTabs": [ { "anchorString": "/ih1/", "anchorYOffset": "601", "anchorUnits": "pixels", "anchorXOffset": "416" } ], "signHereTabs": [ { "anchorString": "/sn1/", "anchorYOffset": "569", "anchorUnits": "pixels", "anchorXOffset": "176" } ] } }, { "e-mail": "paulo.aguiar@elaw.com.br", "nome": "Paulo Aguiar", "recipientId": "58884", "routingOrdem": "2", "guias": { "initialHereTabs": [ { "anchorString": "/ih2/", "anchorYOffset": "660", "anchorUnits": "pixels", "anchorXOffset": "549" } ],

672
Leandro.Reis
Docusign Employee
K
New Voice
Kat0120
asked in eSignature API
REST API - EnvelopeViews : createCorrect error "access denied"

(Post) URL: {{baseUrl}}/v2.1/accounts/c****8/envelopes/f****d/views/correct Body: { "beginOnTagger": "true", "returnUrl": "https://www.google.com" } Reference: createCorrectView | REST API | Docusign Issue: If we say “beginOnTagger:true” then we get “Login Unsuccessful Access denied . Transaction Id: a*****d RETRY LOGIN” What are we missing here?

631
B
Docusign Employee
S
Newcomer
soguazuNewcomer
asked in eSignature API
Retrieving the Schwabs template id via API

I am a developer building an app for financial advisors to manage their clients electronically. To obtain signatures from the clients, I am using DocuSign. Some of the advisors are integrated with Schwab and want to use the Schwab template to create envelopes. My problem is that the Schwab template is not shareable via the GUI, and I was hoping to be able to retrieve this template, specifically 'Schwab Non-Template Envelope To Process,' to use it for creating envelopes. However, this template is not shareable, and I am not able to retrieve it when filtering by template name via the API. On the other hand, when I try this with templates I created myself, everything works fine. What is the best way to get the Schwab template ID so I can use it to create an envelope?

464
S
Newcomer
V
Newcomer
Victor15956Newcomer
asked in eSignature API
How the way to use composite template for updating documents on server template

when I updated 3 documents on server template but public static EnvelopeDefinition MakeEnvelope2(List<string> documents, string templateId, DsRecipients host, List<string> docIds){ var document64s = Base64Document(documents); InPersonSigner inPersonSigner = new InPersonSigner { HostEmail = host.Host.HostEmail, HostName = host.Host.HostName, SignerName = host.Host.SignName, RecipientId = "1", RoutingOrder = "1", }; Signer needToSign = new Signer { Email = host.Signerv.ClientEmail, Name = host.Signerv.ClientName, RecipientId = "2", RoutingOrder = "2" }; Recipients recipientsServerTemplate1 = new Recipients { InPersonSigners = new List<InPersonSigner> { inPersonSigner }, Signers = new List<Signer> { needToSign }, }; List<CompositeTemplate> compositeTemplates = new List<CompositeTemplate>(); for (int i = 0; i < document64s.Count; i++) { CompositeTemplate compTemplate = new CompositeTemplate { CompositeTemplateId = (i + 1).ToString() // Đặt ID của CompositeTemplate theo thứ tự }; InlineTemp

541
Ivan.Dinkov
Docusign Employee
S
New Voice
srleeNew Voice
asked in eSignature API
Reporting Processes Employed by Customers

What are DocuSign customers using to report on DocuSign envelope data, and what is the process involved? Someone out there has to be needing DocuSign data for dashboards and statistics (not found in the delivered reports). Downloading Form data is not an option because there are too many envelopes being processed by a user/area. Agreement Actions seems to have some flaws when it comes to adding or deleting fields from a previously-created spreadsheet. Retrieve is an option but the user is then left to their own devices on formatting, saving, sharing, etc. and leaves little room for standardization or automation. We are looking into DataFeed API, but that seems to bring the same effort as other solutions we have discussed (such as building a database or storing in a data warehouse, connecting to PowerBI, etc.) We have also looked into PowerAutomate (PA), but it seems that whenever changes are made in DocuSign, the same changes have to be reflected in PA as well as other products such as

220
S
New Voice
M
Newcomer
madhu77Newcomer
asked in eSignature API
Open the authorization URL to authorize

I’m trying to write google appscirpt to get docusign signature using OAuth2 service for Authorization Code Grant flow, i have manually run the URL, but from the code i get the following error “Open the authorization URL to authorize”

542
B
Docusign Employee
C
Newcomer
cjmNewcomer
asked in eSignature API
Passing variable values to envelope custom fields

Hi all, sorry if I missed this. My goal is to have each customer have a custom embedded document with ID verification and signing feature. To achieve that, I intend to : 1/ Create an Envelope template with custom fields. 2/ Write the API call to pass information to custom fields and necessary options to make ID verification and other required features. Still need to figure it out.3/ Create the iframe to embed all this. Did I break this down correctly? regarding 1/ I realized I needed to upgrade my standard plan to business pro plan to create custom fields. regarding 2/ I have not found the documentation to map out my variable values to the custom fields variables and test it. Would anyone point me out to the correct direction?

2321
T
Docusign Employee
S
Newcomer
SriniKNewcomer
asked in eSignature API
Rich text enabled form field is getting filled with xml value

I am sending a a document with form fields for signing. Some form fields are getting filled with xml values. I am assuming that these form fields have rich text formatting enabled. How do I make sure that the form fields dont get filled with xml as shown below

281
B
Docusign Employee
K
New Voice
karanvir93New Voice
asked in eSignature API
Docusign API - how to hide the radio button's group name and value

When I hover over the radio buttons it shows the tooltip along with radiogroup name and radio button’s value. I don’t want user to see the radio group name and radio button value when they hover over radiobuittons. how to hide it using Docusign API

703
M
Docusign Employee

Most helpful members this week

Badge winners

  • 1st Question Posted
    NimACChas earned the badge 1st Question Posted
  • 1st Reply Posted
    jenny.martinhas earned the badge 1st Reply Posted
  • 1st Question Posted
    UCB1930has earned the badge 1st Question Posted
  • 1st Question Posted
    Himanshuhas earned the badge 1st Question Posted
  • 1st Question Posted
    JNOhas earned the badge 1st Question Posted
Show All Badges

Popular tags

Code of Conduct

Docusign Community

Code of Conduct