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

eSignature API

Find answers to your Docusign eSignature API questions.

  • 402 Topics
  • 879 Replies
402 Topics
M
Newcomer
meilinglamNewcomer
asked in eSignature API
SOAP API RequestStatus does not return RecipientId

I have use case where I need to uniquely identify a recipient. With REST API, it works fine. However, with SOAP, response does not return RecipientId as documented.https://demo.docusign.net/api/3.0/dsapi.asmx?op=RequestStatus<RequestStatusResponse xmlns="http://www.docusign.net/API/3.0"> <RequestStatusResult> <RecipientStatuses> <RecipientStatus> <Type>Signer or Agent or Editor or Intermediary or CarbonCopy or CertifiedDelivery or InPersonSigner or SigningHost</Type> <Email>string</Email> <UserName>string</UserName> <RoutingOrder>unsignedShort</RoutingOrder> <Sent>dateTime</Sent> <Delivered>dateTime</Delivered> <Signed>dateTime</Signed> <Declined>dateTime</Declined> <DeclineReason>string</DeclineReason> <AutoRespondedReason&

172
I
Docusign Employee
B
Newcomer
BridgetLyonsNewcomer
asked in eSignature API
Dayforce DocuSign Integration going Live

We are rolling out Dayforce and paid for the DocuSign IAM Professional package. We were asked to create a Developer account to demo the application during testing. We have set up the external integration in Dayforce to point to the admin user account and id and base URL. Everything was working. Now Dayforce is Live and we were instructed to go into Dayforce external integrations and Click for oAth Setup and Export Tokens. Clicked and it now matches the tokens in the External Integration area in DF and our DocuSign account information in Apps and Keys. However it is not working. I am not sure if we need to do something else?

611
Alexandre.Augusto
Docusign Employee
R
Newcomer
RabGhNewcomer
asked in eSignature API
Next.js App Router, TypeScript, building DocuSign Api

I installed all needed libraries, including the one for ds types. It’s been extremely difficult to use. I haven’t been able to find working examples. I am at a loss. If anyone knows how to use NextResponse app router, typescript, and docusign to get a route.ts file that could send out an e-signature, I would be forever grateful. This is what I have till now ``` import { NextRequest, NextResponse } from 'next/server';import docusign from 'docusign-esign';import fs from 'fs';import path from 'path'; export async function POST(req: NextRequest) {  try {    const { signerEmail, signerName } = await req.json();     // Initialize the DocuSign API client    const dsApiClient = new docusign.ApiClient();    dsApiClient.setBasePath(process.env.NEXT_PUBLIC_DOCUSIGN_BASE_URL || '');     // Load the private key    const privateKey = fs.readFileSync(      path.join(process.cwd(), process.env.NEXT_PUBLIC_DOCUSIGN_PRIVATE_KEY || '')    );     // Request JWT user token    const results = await dsApiCli

7649
K
Newcomer
M
Newcomer
mfrieswykNewcomer
asked in eSignature API
simple field mapping using api to create an envelope and auto-populate std text fields in a template to create a document for signing

i have a platform that has 20+ fields i want to be able to autopopulate on a predefined template and create an envelope using the api. i have tried every possible way to try and get the fields to map and all of the debug logs look great, but still no fields are autopopulating. my data label values match the fields for creating the mapping and the format of the api calls looks perfect and is generating no errors, but still no fields being mapped.  are there limitations where field mapping will not work in a sandbox account.  any other ideas about what might be causing this issue.  any help appreciated.  debug log here. envelope looks good but nothing on fields mapped. DEBUG: Field Mappings Result{ "propertytitle": "stephanie and lili frieswyk2", "propertyaddress": "26735 rockwall parkway", "propertycity": "new braunfels", "propertystate": "TX", "propertyzipcode": "78132", "propertyprice": 789000, "propertyowneremail": "oneweekendsold@gmail.com", "propertycounty":

533
T
Docusign Employee
T
Newcomer
trungduc74f1Newcomer
asked in eSignature API
Document does not load full page and shows loading so I cannot sign the document

I have a docs file to sign about 246 pages, normally it works but starting from yesterday it only loads me the first 30 pages, then it is showing loading from page 30 onwards, so I can't click the Sign button. There is no change after 5 minutes so I think it is a bug and not a network issue. I also tried in incognito mode, VPN off/on but same result. There is no change from our code, we are using Auto-place with anchorString to auto place the sign tags.You can watch the attached video to see the detailed description of the bug

35416
P
Newcomer
M
Newcomer
meyercdllNewcomer
asked in eSignature API
Need inventory of PowerForm fields within an account

We have built dozens of PowerForms over the years and want to do a comprehensive inventory of the fields within the PowerForms. We are wanting to retrieve the field names, field types and if the fields are required for all PowerForms. Is this possible via API?

222
A
Conversation Starter
N
New Voice
Nicholas H.New Voice
asked in eSignature API
Using API Embeded Signing with User Auto-Provisioning

We are using the embedded signing, so the users do not have to leave our app which means we are using the APIs to facilitate this. We are trying to automate the process of onboarding/auto-provisioning users into DocuSign so they don’t have to go to the DocuSign site first.  We have Auto-Provisioning turned on and it works when a user logs into the portal. My question is, should the auto-provisioning work through the API’s where if we search for a user's email, it will automatically add them if they exist within our domain. Or do we need to have a process that checks if a user exists in DocuSign and add the user if they do not.

7510
N
New Voice
E
Newcomer
evanLiNewcomer
asked in eSignature API
Focus View in Angular doesn't work

Import in index.html<script src='https://js-d.docusign.com/bundle.js'></script> In signing page component:import { Component, OnInit, input, AfterViewInit } from '@angular/core';import { Input } from '@angular/core';import { ActivatedRoute } from '@angular/router';declare const DocuSign: any;@Component({ selector: 'app-focused-view-signing', imports: [], templateUrl: './focused-view-signing.component.html', styleUrls: ['./focused-view-signing.component.css']})export class FocusedViewSigningComponent implements AfterViewInit { integrationKey: string = 'xxxx'; // Replace with your integration key constructor(private route: ActivatedRoute,) { } ngAfterViewInit() { const url = this.route.snapshot.paramMap.get('url'); console.log('Input URL:', url); DocuSign.loadDocuSign(this.integrationKey) .then((docusign: any) => { const signing = docusign.signing({ url, displayFormat: 'focused', style: { branding: {

923
B
Docusign Employee
Scott.Nieman
New Voice
Scott.NiemanNew Voice
asked in eSignature API
Expand GET /{{baseUrl}}v2.1/accounts/{{accountId}}/envelopes to have query parameters that search documents by documentFields[?(name=='text')].value and contains() filter like OData

We need a list of envelopes where the recipient has used Print and Sign feature.  We place a documentType name value pair in documentFields array, but there is no programmatic way to know which envelopes have uploaded documents via the Connect callback interface JSON.There are a lot of other use cases for search. 

767
Scott.Nieman
New Voice
C
Newcomer
CyrineNewcomer
asked in eSignature API
Issue During Go Live - OAuth Consent Error

Hello,I’m encountering an issue when transitioning the DocuSign integration to my client’s production account. Instead of displaying the expected OAuth consent pop-up, I receive an error stating that the page cannot be found. Below are the details of the error:Error: "This page account.docusign.com cannot be found..."Associated URL: https://account.docusign.com/oauth/auth?client_id=9f87e104-a483-405b-ab66-d0bcad57bf62&scope=signature%20admin_consent%20manage_app_keys%20connect_hmac_api%20user_read%20account_read%20user_write%20cors_manage%20manage_system_signing_groups%20account_write%20admin_communication_read%20admin_communication_write%20organization_write%20organization_read%20account_product_read%20group_management_read%20group_management_write%20me_profile%20search_read%20search_write%20organization_data_feed_config_read%20organization_data_feed_config_write%20organization_monitor_config_read%20organization_monitor_config_write%20organization_monitor_events_read%20notary_read

503
Hengfeng Ge
Rising Star
JohnSantos
Valued Contributor
JohnSantosValued Contributor
asked in eSignature API
Purging documents

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?

614
B
Docusign Employee
N
Newcomer
NoelleWNewcomer
asked in eSignature API
DocuSign access code prompt & signer fields don't appear when signer is added during the createSenderView step

Hi, all! I’m recently encountering an issue where the access code prompt isn’t appearing for signers that I add during the “CreateSenderView” step of my workflow. Workflow: Person A creates an envelope through an external DocuSign integration and adds Signer A as a recipient of said envelope. Person A proceeds to the sender’s view on the DocuSign site. (This is done using envelopesAPI()->createSenderView()) Person A adds a new signer, Signer B. Signer B is assigned an access code. Person A returns to the external DocuSign integration and creates a recipient view for Signer A to sign. (This is done using envelopesAPI()->createRecipientView()). Signer A is prompted to enter their access code, enters, and completes signing.  Person A creates another recipient view for Signer B once Signer A has finished.  Signer B is not prompted for an access code and doesn’t see the fields added for them to sign.Note: Person A is authenticated in this integration using OAuth and has a different em

435
N
Newcomer
K
Newcomer
knowrahuljNewcomer
asked in eSignature API
Purging documents via API

Hi,I have a usecase where contracts are created using a salesforce workflow through a user and I am trying to purge those contracts via APIs. While purging documents I am getting an error that only the sender can add documents to purge queue.I am purging documents via APIs and docusign does not allow to add API user to act on behalf to docusign Users. Is there a workaround for this which would enable be to purge documents created by other users?

173
Hengfeng Ge
Rising Star
O
New Voice
Oli.MNew Voice
asked in eSignature API
US Signatures not listed in ListSignatureProvider REST API

Dear all, I need to configure for US colleagues the next API connection. I look for the following but for all available US Pen in DocuSign : {"signatureProviderId": "412","signatureProviderName": "transsped","signatureProviderDisplayName": "Trans Sped SAFE/eIDAS digital certificate","priority": "2","isRequired": "false"}Normally I use the API explorer tool but it doesn't catch the US pensDigiCert US Signer Held Notary U.S. USAID PIV PIV Smart CardsRegardsolivier 

241
Ivan.Dinkov
Docusign Employee
T
Newcomer
TechniqueNewcomer
asked in eSignature API
Bad request - Docusign JS embeded - The form is signed but "sessionEnd" is not triggered

How to reproduce my bug : Generate a enveloppeView Sign the enveloppe The signing.on(‘sessionEnd’) isn’t triggered I was a valid docusign integration and it works on dev environnment 

251
B
Docusign Employee
K
Newcomer
kapil775Newcomer
asked in eSignature API
Dosusign Access token generation API

Hi All, I am having a basic query related to Docusign API. This query is more of API related rather than Docusign related, however still posting here as it concerns Docusign. I am following this video for querying docusign API. Here at timestamp 5:44 the API body is passed as ‘x-www-form-urlencoded’(snapshot attached). However, I am making this API call using my automation tool(Uipath) which lacks the ‘x-www-form-urlencoded’ interface similar to postman. It is possible to pass the body as JSON instead of ‘x-www-form-urlencoded’? I tried passing JSON body as below but it didn’t work. {“grant_type”: “authorization_code”, “code”: “<code>”} Thanks! 

271
karan.kaushik
Docusign Employee
L
Newcomer
Limber SoftwareNewcomer
asked in eSignature API
Missing phoneNumber attribute in Signer interface (TypeScript)

Hello everyone!I’m developing an integrator to send documents from our ERP to DocuSign for digital signatures. The email sending is working, but I’m encountering an issue with WhatsApp sendingMy project uses Node.js with TypeScript, so I’ve typed the recipient using the interface exported from the @types/docusign-esign library. However, this interface doesn’t include the “phoneNumber” attribute, which is needed to send the phone number object as shown in the example project (see the images below).My Project:Node.js eSignature REST API Example: Could this be a missing attribute in the library’s interface?

281
Alexandre.Augusto
Docusign Employee
A
Newcomer
ajmorgsNewcomer
asked in eSignature API
Can the same app key be used for different

I have an app key setup and live in production. When a user clicks a button on my page I create an envelope and send a PDF with a request to Docusign for the user to sign. This has been working for several years. Is it possible to use the same app key to send a different PDF for signing, or do I have to create a separate app key?The return URL will be different for the other PDF, but it looks like I can add multiple return URLs to the app key configuration.

141
Alexandre.Augusto
Docusign Employee
D
Newcomer
DetroitMMIllerNewcomer
asked in eSignature API
Receiving 401 Unauthorized when attempting to list users with JWT Token

I am following the tutorial from this page: How to get an access token with Implicit Grant | DocusignI have an href to the following URL: https://account-d.docusign.com/oauth/auth?response_type=code&scope=impersonation%20signature%20organization_read%20user_read%20account_read%20dtr.profile.read&client_id=#redacted#&redirect_uri=https://localhost:7054/dsauthWhen I follow this href I am directed to log in and grant permission.  I am successfully redirected back to https://localhost:7054/dsauth.  I capture the token from the “code” query parameter.When I try to use that token in the header to list users, I receive 401 unauthorized.  I can’t find any documentation to help resolve the problem, and as far as I can tell I’m following the example perfectly.I am using C# and RestSharp to make the calls.  Following is the relevant code: async void GetUsers() { var client = new RestClient("https://account-d.docusign.com/oauth/userinfo"); var request = new RestRequ

703
D
Newcomer
D
Newcomer
Danny OnDNewcomer
asked in eSignature API
Why aren't envelopes submitted via API appearing in Agreements?

I have made a number of API submissions during PoC process, these have been delivered either to the Sent or Drafts folders. I have gathered the envelopeId’s and can access the envelopes directly, however they do not appear in the Agreements view. (The latest viewed one does appear if I navigate to Sent/Draft via the info on the envelope detail view, but it only shows the one envelope). How can I see a list of all my Drafts?  PS> Is it possible to select and send multiple drafts at once?

293
D
Newcomer
R
Newcomer
RutujaNewcomer
asked in eSignature API
Skip Go Live and create production account directly

Is is compulsory to create a developer account and then migrate to production after submitting app for review? Can I create app in production environment directly to use DocuSign API?

321
JohnSantos
Valued Contributor
L
Newcomer
LiliyaNewcomer
asked in eSignature API
Implementation of Counter-Signature Functionality - Envelope Does Not Transition to "Completed" Status

Hello,I am trying to implement a counter-signature functionality in DocuSign sandbox env and encountering an issue where the envelope does not transition to the "Completed" status as expected. Below is the workflow I am attempting to implement and the problem I am facing: Template Setup: My template has two roles: Customer (Role 1): Configured as need to sign, with required text fields and a signature field. This role has a routingOrder of 1. Company (Role 2): Configured as need to sign, with required text fields only. This role has a routingOrder of 2. Envelope Creation: At the time of envelope creation, I programmatically fill all required text fields for the company role using the API ( also try to fill text fields after the customer signature complete ) . The customer role receives the envelope and is expected to sign and complete their part. Customer Signing: The customer role completes all required fields and signs the document. At this stage, the customer should not se

252
A
Conversation Starter
K
Newcomer
kapil775Newcomer
asked in eSignature API
‘Object reference not set to an instance of an object’ Docusign create envelope REST API

Hi All, I am working on creating an envelope using API explorer in developers.docusign.com. I am able to send the document if I am not attaching any tabs to the document. However I am getting the below error if I am attaching tabs to the document. Kindly assist me with this issue. I have updated the url and body of my request. {  "message": "Bad Request",  "response": {    "errorCode": "UNSPECIFIED_ERROR",    "message": "Object reference not set to an instance of an object."  }} URL:/restapi/v2.1/accounts/<accountId>/envelopes Body:{  "documents": [    {      "documentBase64": "<base64ForTheDocument>",      "documentId": "1",      "fileExtension": "pdf",      "name": "document",      "tabs": {        "signHereTabs": [          {            "anchorString": "Signature:",            "documentId": "1",            "anchorXOffset": "1",            "anchorYOffset": "0",            "anchorIgnoreIfNotPresent": "True",            "anchorUnits": "inches"          }        ]      }    

301
Hengfeng Ge
Rising Star
J
Newcomer
jreynerioNewcomer
asked in eSignature API
CUstom API integration to generate Remote Sign

Hello, I am working on developing a web application that requires integration with Docusign to request signature of some documents, just to put you in context my application sends an SMS to a user and depending on the user's response the document signature request must be sent, the request must be sent by SMS and also the entire envelope creation process must be done in my API without requiring user intervention, so I want to know if this project idea is reasonable and what authentication method I should use for this project. I would greatly appreciate if you could help me with this question. I only have to add that my API is being developed using NodeJs. Thanks in advance.

575
E
Docusign Employee
T
Newcomer
thomas ONewcomer
asked in eSignature API
additionnal Notification not working

Hello,I have a problem When I build my envelope with additionalNotification,I want a SMS notification but the Docusign API say that my vountry_code is not present. But I made that (in PHP) :                         $additionnalNotification = new \DocuSign\eSign\Model\RecipientAdditionalNotification([                            "secondary_delivery_method" => "SMS",                            "phone_number" => [                                "country_code" =>”33”,                                "number" => “625589878”                            ]                            ]); The country code is the country code of france. I get: Error while requesting server, received a non successful HTTP code [400] with response Body: O:8:"stdClass":2:{s:9:"errorCode";s:34:"INVALID_PHONE_NUMBER_FOR_RECIPIENT";s:7:"message";s:73:"The Phone number is invalid. Country code is missing. Recipient id: 10511"

373
E
Docusign Employee

Badge winners

Show All Badges
Code of Conduct

Docusign Community

Code of Conduct