DocuSign Api - Sender View & EDIT_LOCK_ENVELOPE_LOCKED - docusignapi

Can anyone help.
I’m using the rest api to create an envelope, and then configure it using the api sender view call (/restapi/v2/accounts//envelopes//views/sender) to get the DocuSign UI.
Creating the envelope and viewing it the first time using sender view to bring up the docusign api works fine.
The problem occurs if instead of sending the envelope I click ‘save as draft’. When I try to go back to the envelope and view it again using sender view I get the following error with http status of 400:
{
"errorCode": "EDIT_LOCK_ENVELOPE_LOCKED",
"message": "The envelope is locked. The lock must be released before requesting the sender token for envelope, id = xxxxxxx-xxxx-xxxx-xxxx-xxxxxxxx."
}
The lock seems to wear off after time (apprx 20 mins). However after it wears off I can only view the item once, and then the lock is reapplied.
I can’t find anything in DocuSign api documentation that relates to this behaviour. Any help would be appreciated.
UPDATE (12/Feb/15): This error only happens on my demo account but not on production, so it seems like it's an account setting, but I can't figure out what/where the setting is.
Thanks,
Nick

Yes - there is new documentation about this envelope locking feature and behavior in the February service pack (PDF) available here: https://www.docusign.com/support/releases.

We have a bug logged on our side where Save Draft isn't correctly releasing the lock on the envelope. We should have a fix for this issue in our DEMO environment soon. The locking feature is currently only "ON" in our DEMO environment but not in our Production environments while we find and fix potential issues such as the one identified here. More information about locking is in our February service pack (PDF) release notes available here: https://www.docusign.com/support/releases.

Related

DocuSign Connect API brands could not be created

My website has been using DocuSign Connect API (SOAP) for years without issue. Part of my website utilizes the brand creation functionality of the DS API (CreateAccountBrands). This has worked flawlessly until very recently.
I now notice in the DocuSign Demo environment that the CreateAccountBrands calls return an InternalServerError with the message "Brands could not be created" but no other information is present in the trace log file. All other DocuSign API calls still seem to be working fine.
Nothing with my payload has changed at all. Has something recently changed with the payload requirements of the CreateAccountBrands call?
I thought it could be that you reached the limits for brands but it seems to be 1900+
You can check Docusign's release notes to see if there are any relevant changes here: https://support.docusign.com/s/releasenotes?language=en_US&page=1
If you don't find anything then you can reach out to DocuSign's support by opening a ticket here: https://support.docusign.com/

Recipient Delivery Failed -- Webhooks and Correcting/Resending via the API

I've been working on an integration that sends an envelope to 2 signers. I am trying to test and program for the case of 1 of the signers having a bad email address. I would need to:
Be notified of this (webhook?)
Update the email address for the signer
Update the email address in the custom fields as that's printed on the agreement
Resend the envelope
When I enable the delivery failure notification in Connect (this is set up at the account level, for now), I don't see where the failure is noted in the webhook response or for which signer the error is happening.
I've found multiple links via Google talking about "correct and resend" but I haven't been able to get anything definitive in terms of what steps need to be taken or a (PHP) code example. I've also found "resend" in the API reference but still no code examples.
I also haven't seen any code examples (PHP) of how I would update a signer's email address and how that would work via the API.
It'd also be good to know how to update custom field data for both signers so the email address in the contract is updated (it's listed separately as part of the custom form data).
And finally, how would I resend the envelope?
Thank you for your thoughts.
Per DocuSign support (customersupport#docusign.com):
Be notified of this (webhook?)
I have updated your account settings and now you should be able to see AutoResponded in your webhook messages when email invalid or unreachable.
(my comments: so it sounds like you have to ask to be able to see this stuff, it's not part of their standard webhook responses)
Update the email address for the signer
I also haven't seen any code examples of how I would update a signer and how that would work.
Unfortunately we don't have an example for recipient update but the logic is to get list of all recipients, pick the one need to be updated, and update.
You can use below to retrieve all recipients per envelope
https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/enveloperecipients/list/
GET /restapi/v2.1/accounts/accountId/envelopes/envelopeId/recipients
Extract the one you need to update edit email and update using the below
https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/enveloperecipients/update/
PUT /restapi/v2.1/accounts/accountId/envelopes/envelopeId/recipients
You can also see example code in C# how to do this in this thread https://github.com/docusign/docusign-csharp-client/issues/307
Update the email address in the custom fields as that's printed on the agreement
There is bug case created ( above link ) regarding this. At the moment you can not update signer custom fields case EC-2944.
Resend the envelope
You can resend the envelope during recipient update
https://developers.docusign.com/docs/esign-rest-api/reference/envelopes/enveloperecipients/update/
PUT /restapi/v2.1/accounts/accountId/envelopes/envelopeId/recipients
My commentary:
Since custom fields can't be updated, this whole use-case goes out the window. We can't have contracts with incorrect data on it, so my client will have to do these corrections by hand. Kind of a bummer.

Docusign Envelope Corrected - As a result, you no longer have access

I've been working with a docusign integration into our own application for a while, and recently I've started encountering a new error that I've never experienced before. I create a docusign envelope using Docusign's own interface, add my recipients, set up the signing fields, and then click send.
An email goes out to the users with a link for them to sign the document, as expected. But simultaneously, there is another email that says the following:
[My User] has corrected [My Document].
As a result, you no longer have access.
I click on the link for signing the document, and it results in the following:
In theory, this makes sense. If an envelope is edited or corrected, then the previous links are no longer valid. However, the envelope is never being corrected. It is created and sent in a single action. There isn't even time for a correction to be made. I'm the only person with access to the account, so no one else can be making corrections to the envelope. Additionally, this only seems to occur for certain recipients. Some recipients are fine, and this correction thing doesn't occur. For others, it happens and breaks the entire chain.
What could be causing Docusign to do this? I'm working with a developer account if that makes any difference. The only recent change that was made to my configuration is the addition of Connect with HMAC signatures to verify the validity of docusign responses back to my application. Even so, most of the time things seem to work exactly as intended and expected.

how to get the signed document and response after signing in Docusign

So i am using docusign and testing the api with a simple index.php type project and i have successfully sent the document to the email provided in the
$signerEmail = 'test#test.com' using docusign api-client
now after it have signed the document and finish it by clicking at the finish button in docusign window. I want to retrieve the response and document on which it have given its information.
how can i achieve this and right now i am having difficulty to find it in the documentation.
There are 2 ways to do that, synchronously and asynchronously.
Or in other words, if you know the document is already complete, you can run the code, or you can use a webhook with notifications from DocuSign letting you know that the envelope is complete.
Regardless, the API to retrieve a document is this:
GET /v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}
or you can use it from the PHP SDK as well.
Hope this helps.
A full code example (in PHP as well) can be found here - https://developers.docusign.com/esign-rest-api/code-examples/code-example-download-envelope-documents

Unable to Load a document into Docusign

We are using docusign for more than 3 years, We have several demo accounts as well as we have paid account too.
we are using the following docusign rest service
https://demo.docusign.net/restapi/v2/accounts/*****/envelopes
In our local environment we are using the above demo rest service, Till last month (August) we were able to post the document into docusign without any issues. The Problem now is that we are not able to post a document to docusign.
we getting the exception like
"errorCode": "UNABLE_TO_LOAD_DOCUMENT", "message": "Unable to load the document. Unable to load Document(1;CONSENT FORM). Error: Cannot add the widget (connected to field: ColombiaCurrentlyresideYes) to page -1, because it's already added to page -1. If you want to re-use this widget, please remove it from the current page first
Same data worked till last month (August) and it's working fine now in docusign production account(paid). we are not sure what went wrong in demo accounts. Any release are done in demo accounts?
I tired using the same template in web console too, same error throws in browser console
Please help me to resolve this issues.
We require your guidance regarding this issue!
I suggest first trying to load the documents into an envelope by using the DocuSign Web tool (NDSE). If that doesn't work then the document is the issue.
Has the document changed?
Re changes: Yes, the demo system is changed each month. Then the changes are applied to the production systems. While we do have thousands of automatic regression tests, problem can creep through the system.
I suggest you contact DocuSign customer support to give them the document which is failing to load.

Resources