I just started suing DocuSign's sandbox to test some of the API call that I plan to use on my website. I was testing the call that returns the information about a particular template. I set up a template in my sandbox and emailed it to myself. I then tried to get the template info by making this call:
Envelope envInfo = envelopesApi.GetEnvelope(accountId, envelopeId);
In the JSON that I get back the value for "status" is "template", which is not one of the possible statuses according to DocuSign (https://www.docusign.com/p/RESTAPIGuide/Content/REST%20API%20References/Get%20Envelope%20Status%20Changes.htm). If anything it should be "Delivered". Has anyone had a similar issue? Thanks.
It was my own dumb error - I was checking the template ID instead of the envelope ID.
Related
ERROR: Content Type specified is not supported.
Hi there, I am new to DocuSign and I am trying to learn the implementation from last couple of days. What I did so far is, created a developer account and created a QuickStart project.
Goal
I want to integrate the DocuSign API's in my application, but I don't really want the user to leave my application. I just want to make use of DocuSign within my app. - Embedded Signing
What I did?
I successfully created an envelope with a sample document and after that I have to get that URL to view (for Recipient).
So I called the below API:
** EnvelopeViews: createRecipient**
** POST - {{baseUrl}}/v2.1/accounts/{{accountId}}/envelopes/{{envelopeId}}/views/recipient**
All the details, like accountId, envelopeId are correct, along with that the request body that I pass with this is:
Request Body
{
"authenticationMethod": "none",
"clientUserId": "bcc49234-f30b-XXXX-XXXX-XXXXXXXXXXXX",
"email": "abc#gmail.com",
"recipientId": "007",
"returnUrl":"http://localhost",
"userName": "user name"
}
Note: * clientUserId is my Integration Key (please let me know if this is what I need to pass here or something else).*
Response
{
"errorCode": "INVALID_CONTENT_TYPE",
"message": "Content Type specified is not supported."
}
Note: Apart from the solution, please provide any link(s) to resources where I can easily see the implementation(as in my use case).
Umair,
First clientUserId is a bit of a confusing term, it's not the IK (Integration Key) but any string you want. It is unique to the signer and the envelope. You choose it.
You can find a detailed example of this with code in 8 languages on the DocuSign Developer Center How To Request Signature Through your app page.
I'm not clear how you make the API calls, if you are using postman, there are headers that needs to be set. One of them is called Content-Type and it has to be set to text/plain.
I work on the eSignature API, and i wonder if i can change the owner/sender of the envelope during the signing process! For exemple if the owner/sender is in vacation at the end of the process can he be replace ?
And the property of the envelope can be change to be at his name ?
Thank you for your response!
First, this is how you do it from the web app:
https://support.docusign.com/en/guides/ndse-admin-guide-transfer-envelopes-templates
The API endpoints are here - https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/envelopetransferrules/
We don't yet have code examples for this I'm affraid.
I am re-sending documents via the API. This has worked for a long time, and suddenly started getting these errors? I can't figure out what is going on? Does anyone have any ideas?
The actual envelope status is 'Waiting on Others', which of course is not in the list below, but we need to resend the envelope, because the user never got the email. So how do I deal with this?
{ "errorCode": "ENVELOPE_INVALID_STATUS",
"message": "Invalid envelope status. Envelope status is not one of: Created, Sent, Delivered, Correct." }
EnvelopesApi envelopesApi = new
EnvelopesApi(GetBasePath(myAccount.BaseUrl));
envelopesApi.Configuration.AddDefaultHeader(
"X-DocuSign-Authentication", JsonConvert.SerializeObject(myHeader));
EnvelopesApi.UpdateRecipientsOptions options = new
EnvelopesApi.UpdateRecipientsOptions();
options.resendEnvelope = "true";
envelopesApi.UpdateRecipients(myAccount.AccountId,
EnvelopeId, docuSignRecipients, options);
You're not showing what the docusignRecipients value is.
I suggest you first obtain the recipients object via EnvelopeRecipients::list and then use it in the call.
Also, at the API level, there is no envelope status of Waiting on Others. I suggest you also obtain the envelope status so you can see what is going on.
I'm sorry to hear that your code was working and then stopped. That would indicate a regression test problem. Does your code still work on demo?
I am getting "The recipient you have identified is not a valid recipient of the specified envelope" error for new envelopeID: f3a10b34-8f37-41fd-9338-e3a48b30acec
Whereas, I receive embedded link response for previous envelopes with envelopeID: 531e6028-b246-4227-ae45-1c5ad61f89ed.
Am I doing anything wrong or this is a new issue?Can you please look into this?
Thanks!
Never mind, my mistake. I missed to set RecipientCaptiveInfo info for an envelope.
I have issues with getting the ID for the newly created envelopes when using the bulk send feature.
I'm using a template that has a bulk recipient signer (from a CSV file).
I've managed to create with success a draft envelope with a bulk recipient signer based on the template, to pass the CSV file to the envelope and to change the status to 'sent' in order to trigger the sending of an envelope for each recipient.
The issue is that the response returned from sending the envelope doesn't contains the 'bulkRecipientTransactions' element (the CSV file contains 2 signers).
Below you can see a response sample:
<envelopeUpdateSummary xmlns="http://www.docusign.com/restapi" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
<bulkEnvelopeStatus>
<batchId>97ef8125-b305-4de7-837b-d89c36bd994e</batchId>
<batchSize>2</batchSize>
<bulkEnvelopesBatchUri>/bulk_envelopes/97ef8125-b305-4de7-837b-d89c36bd994e</bulkEnvelopesBatchUri>
<failed>0</failed>
<queued>2</queued>
<sent>0</sent>
<submittedDate>2015-07-24T07:10:18.9900000Z</submittedDate>
</bulkEnvelopeStatus>
</envelopeUpdateSummary>
The same result came back when i've used the DocuSign API explorer for creating & sending a bulk recipient envelope - no 'bulkRecipientTransactions' element.
Also I've tried to check the status of one bulk send batch (/accounts/{accountId}/bulk_envelopes/{batchId}), but I've got as a result only the general batch info's - the element 'bulkEnvelopes' was missing!
<bulkEnvelopeStatus xmlns="http://www.docusign.com/restapi" xmlns:i="http://www.w3.org/2001/XMLSchema-instance">
<batchId>97ef8125-b305-4de7-837b-d89c36bd994e</batchId>
<batchSize>2</batchSize>
<bulkEnvelopesBatchUri>/bulk_envelopes/97ef8125-b305-4de7-837b-d89c36bd994e</bulkEnvelopesBatchUri>
<endPosition>2</endPosition>
<failed>0</failed>
<nextUri/>
<previousUri/>
<queued>0</queued>
<resultSetSize>0</resultSetSize>
<sent>2</sent>
<startPosition>0</startPosition>
<submittedDate>2015-07-24T07:10:18.9900000Z</submittedDate>
<totalSetSize>2</totalSetSize>
</bulkEnvelopeStatus>
For all the workflow I've used the REST API v2 using C# and xml.
When you use /accounts/{accountId}/bulk_envelopes/{batchId} to get envelopes, you need specify queryString ?include=(all,failed,queued,sent).otherwise, you may not get any envelopes list result