docusign rest api - preview the envelope - docusignapi

I am using rest api for docusign integration.
I am creating the envelope with multiple templates ( using composite template)and trying to preview it in readonly mode.
In my case, the the work flow goes like this... Rep ( Creates envelope and previews it in readonly mode). If everything looks good in preview, then click sent button in my App UI, which will actually sent the envelope to 3 remote recipients ( signer 1, signer2, signer3 -these are actual signers).
I am able to create and sent but not able to preview the envelope in read only mode.
1) Tried downloading the document as byte[].. but the prefill field data is missing
2) Tried by adding a previewer role to the templates and then make him as embedded user. Then created recipients view.. this again is missing the prefill data.
How to preview a created envelope in non editable mode with prefill field data?

Enable "Display SecureField initial value to all recipients" in Preferences --> Features and then the downloaded document (post send) should have all the tab data filled in. However, this will also show tab data to other recipients, Signer 1 will see tab data prefilled for Signer 3 during signing.

Hello All I am able to download the documents from envelope that is in draft ..created status.
1) Do as Rickey told in above answer and then I used below url condiftions.
/documents/combined?watermark=true&&show_changes=true

Related

Ability to modify template tabs to have values in an envelope when a template is applied to an envelope

I am using docusign APIs to use an existing template when i send an envelope. In the Envelope definition (env), using env.setTemplateId(), i am able to set the template to the envelope. I want to be able to edit the tabs (to make them read-only and populate values) added through the template only in the context of the envelope (without modifying the template).
But on trying to retreive the envelope contents, the tabs are not listed as part of the envelope.
Any pointers on this?
Have seen a few similar questions (Docusign API - prefilling tab values on envelope created from template, Docusign API - prefilling tab values on envelope created from template), but no concrete solution yet.
By default GET on an envelope would not retrieve the tabs. You can do that by making this API call:
GET /restapi/v2.1/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}/tabs
Which requires that you know the documentID.
If you are using one of our SDKs, you can see code examples that do just that here:
https://developers.docusign.com/esign-rest-api/code-examples/set-template-tab-values

Is there a way to get a enveloped document with all custom fields populated on it, using Docusign Rest API?

I am working in a implementation using Docusign to e-sing some documents , I am able to create the envelope successfully a, but when I use the API to get the document in order to show to the user the document before to be signed the document is empty without the custom fields (tabs) that I have set in the template, so my question is : is there any way to get a document with all custom fields populated even is the document had not been signed?
I have tried using the Docusign REST-APIS to get the document:
GET/v2/accounts/{accountId}/envelopes/{envelopeId}/documents/{documentId}
That works I am able to get the PDF file but I dont know why the custom fields are not present in the document
If you want to get PDF with the prepopulated tabs data and want to send for review to Sales Officer then you can achieve it by two ways:
If envelope is created with sent status, then you can add Sales
Officer as the first Recipient as Signer Type and add a Approve Tab
for that signer, that way if Sales Officer approves then DocuSign
will move to next recipient in the workflow and if Sales Officer
declines then workflow will stop. So with this approach, everything
is handled by DocuSign and you do not need to get PDF copy and then
get approval via Email by sending PDF as an attachment, also approval
or decline is captured in the audit trail and also in CoC.
If envelope is created with draft status, then you can download the
PDF with prepopulated tab data by using below API call,
https://{{EnvironmentVal}}/restapi/v2/accounts/{{AccountIdVal}}/envelopes/{{envelopeId}}/documents/{{documentId}}?show_changes=true
to make any of the above solution work, you need to need to enable a Sending Setting under Admin at an Account Level which will show the Tab Value on the document for everyone.
There's an account-wide setting for this.
Navigate to Go to Admin > Sending Settings > When an envelope is sent, write the initial value of the field for all recipients.
As far as I know this can't be toggled at the envelope level by the API.

Landing to Particular form in Embedded Envelope with multiple forms

My requirement :
Creating DocuSign embedded envelope which contains multiple documents(doc1,doc2 and doc3) for signing by single signer. I want to be generate embedded signing url(one time url) which will land me to desired document - say on doc3 directly.
is it possible to achieve this in DocuSign?
When a recipient first enters/opens an Envelope, they'll always see the first page of the first document initially -- there's no way to have DocuSign automatically scroll down to a subsequent document in the Envelope as soon as the Envelope is opened.
However, you can somewhat control 'auto-navigation' by using the Account-level setting "Signing auto-navigation rule" (located in Preferences >> Features page of the DocuSign web console...and described on page 27 of the Admin guide: http://www.docusign.com/sites/default/files/Account%20Administration%20Reference%20Guide.pdf).
If you set Signing auto-navigation rule to "Navigate blank required fields" as I've shown above, and the Envelope contains 3 documents, but only the third document requires input from the signer (i.e., no incomplete required tabs for the recipient are located in the first two documents), then the user experience will be as follows:
Recipient opens Envelope and sees page 1 of doc 1, with a "Start" button shown on the left:
Recipient clicks the "Start" button and the envelope automatically scrolls/navigates down to the recipient's first required tab (located in document 3):
So, using the Signing auto-navigation rule setting as described above may somewhat allow you to meet your requirement, depending on which Envelope documents in your scenario contain required tabs for the recipient.

DocuSign REST API Remove EnvelopeID from PDF

I am using the REST API to submit documents for InPerson signing from my website. When the documents are completed signing, Docusign inserts the EnvelopeID at the top of the resulting PDF document. This results in the EnvelopeID covering critical document information. We need to REMOVE this envelopeID from the document, or at the very least move to the bottom of the page. Our account has the "Envelope ID Stamp Control" feature enabled and it is selected on the Preferences|Features page, but the EvnelopeID continues to appear at the top of the finished PDF. I have been unable to locate articles on how to implement this feature via REST API. What Envelope settings need to be submitted in order for us to suppress the EnvelopeID stamp on the finished PDF?
Many Thanks in Advance
ward
The "Envelope including the Envelope ID on the Document" feature in Settings >> Sending Settings gives you the ability to set the Default ID stamp behavior (enable or disable) for Envelopes that are sent via the account. If you NEVER want ID stamped on any of the envelopes sent via the account, then click the "Envelope ID stamp control" link, uncheck "Include Envelope ID by Default" and Save.
Additionally, even if the ID Stamp is enabled at the account level (i.e., "Include Envelope ID by Default" is selected in Settings >> Sending Settings >> Enable including the Envelope ID on the document), you can still override this setting for each individual envelope you send. Via the REST API, you should be able to do so in the API request to Create the Envelope (POST /accounts/{accountId}/envelopes), by setting the envelopeIdStamping property to false -- to prevent the stamp from being added for the envelope being sent.

Reuse/alter a DocuSign envelope, to update its document PDF, once the envelope is In Process

We need to be able to handle a scenario where the document PDF needs to be updated and resent, after the envelope is In Process. Do we always need to create a new envelope or can we reuse the current envelope ID?
Our process goes roughly like this:
A PDF document is generated (not using a DocuSign template).
We create an envelope for the document PDF.
The first signer (our employee) signs the document (using an embedded signing page).
The other signers sign the document (also using an embedded signing page).
Firstly, we want to know if we're forced to incur another "sent" envelope (i.e. we're billed) every time we want to update a document PDF. Secondly, we're looking for a clean way to implement updates, without the need to manage multiple envelopes.
Yes you will unfortunately have to make a new envelope if you want to make changes to the underlying document(s) of the envelope after it has been sent. This is actually a fundamental part of the service and the reason is not to make you incur a new envelope - instead it's actually a security / legal requirement.
Imagine that we are in the old world and I need two people to sign a document on paper. I have the first person sign, then before the second person signs I make a change to the document that says the first person owes me $1,000,000. Then the second person signs, the document completes, and now you have a signature from both people but it contains content that the first person did not actually agree to (and they apparently owe you $1,000,000 now!). That's the main reason why you can't change the underlying document once it's been sent.
Two possible workarounds I can think of:
1. Add data fields or other Stick-eTabs to the envelope for the parts of the document that might change.
2. Use the signer attachments tab to add additional documents.
For #1, let's say you send out a sales contract for $100,000, but after it's been sent a new price is determined. If the $100,000 is in the document content itself then you can not edit it and you'd have to create a new envelope with the new document; however if it's through a Data Field then your recipients can simply edit the value as the document works towards completion.
For #2, there are special Stick-eTabs you can add called Signer Attachment Tabs which allow recipients to attach whole documents and other files to the envelope. You could utilize this to add your changes to the envelope.
Is there a human involved in updating/replacing the document, or are you looking to fully automate the process with the API? As Ergin stated, it's not possible to add/remove documents using the API once an Envelope has been Sent. However, it IS possible for the Sender of the envelope to "Correct" (and re-send) the Envelope using the DocuSign web console -- including adding or removing documents for an Envelope that's already been Sent, but documents can be ONLY be removed/replaced IF none of the recipients have yet acted on the Envelope. i.e., once at least one recipient has acted on the Envelope, it won't be possible for the Sender to remove/replace documents in the Envelope (although they can Add new documents, as long as the Envelope is still in-process).
You can use the API to launch the "Correct Envelope" view as follows:
POST https://demo.docusign.net/restapi/v2/accounts/{acctId}/envelopes/{envelopeId}/views/correct
The response to this operation will return a URL that you can use to launch the "Correct Envelope" view.
Finally, one important caveat about using the "Correct Envelope" feature to enable the Sender to modify documents in an envelope: once the person is logged into the DocuSign web console where they'll correct the envelope, they'll have full access to that user account in the DocuSign web console -- i.e, they'll be able to access all Envelopes in that user account (Sent Items, Inbox, Deleted Items, etc.), send new Envelopes, access user settings via "Preferences", etc. So, be careful using the Correct view if you're concerned at all with providing the person with full access to that user account within the DocuSign web console.
Note: In order for the Sender to be able to add/remove Documents in the "Correct Envelope" view, the "Advanced Correct" feature must be enabled for the DocuSign account (in Preferences >> Features).

Resources