I have added textTabs for a signer in an envelope using the DocuSign API.
I would like to request the information which the user has entered into the textTab. How can I do that?
I found the following hint:
Retrieving information from a signed document DocuSign API
But when looking into the REST API documentation it is stated that the API retrieves the original value (originalValue) of the tab when it was sent to the recipient.
That is exactly the behaviour I had discovered.
Does there exist any other method to retrieve the data entered by the signer?
Here are two approaches to get the tab values for an envelope:
1) envelopes/(envelopeID)/recipients?include_tabs=true. This will return all tab values for every recipient on the envelope. It does NOT include the originalValue property of a tab though.
2) envelopes/(envelopeID)/recipients/(recipientID)/tabs. You will need to explicitly hit the tabs endpoint for every recipient. This will display the originalValue property. Example: ../envelopes/5ad452d5-3004-4b8b-b4d1-ef90f02f2c45/recipients/1/tabs
Related
I'm using the docusign api and am having some trouble with a query string param. Basically I'm trying to grab the recipient information of an envelope along with the status of the envelope in a single call.
I am able to grab each of information individually with the following api calls and they both work
1.) Envelope endpoint (has a status field with overall envelope status such as Signed, Voided, Declined, etc...):
https://na2.docusign.net/restapi/v2/accounts/:accountId/envelopes/:docusignEnvelopeId/
2.) Envelope/recipients endpoint (has information regarding recipients)
https://na2.docusign.net/restapi/v2/accounts/:accountId/envelopes/:docusignEnvelopeId/recipients
However, I'm trying to see if I can grab these information all within one API call. According to the docs here for the general envelope endpoint, I think I should be able to with a query param
https://developers.docusign.com/esign-rest-api/reference/Envelopes/Envelopes/get#request.
Under the include Optional Query Parameters section, there's a param for "include" which says I can grab recipients from the 1st endpoint. "Specifies additional information about the envelope to return. Enter a comma-separated list, such as tabs,recipients. Valid values are..."
I've been trying to modify the first endpoint with this include param to look something like this...
https://na2.docusign.net/restapi/v2/accounts/:accountId/envelopes/:docusignEnvelopeId?include=recipients
But I have been unable to have recipients show up as well. Was wondering if I'm just typing in the param wrong or if this is not available anymore. Any help would be appreciated!
Thanks :)
The include parameters were added in v2.1 of the eSignature API, so they don't work in v2. Changing your URL to https://na2.docusign.net/restapi/v2.1/accounts/:accountId/envelopes/:docusignEnvelopeId?include=recipients should return the recipient info.
I have created a template in DocuSign with a number of fields. I have also built an application that creates an envelope from that template and sends it using the REST API.
In that process I also would like to prepopulate those fields in the envelope document before sending to the first recipient. For achieving this I have looked at the update method for recipient tabs (https://developers.docusign.com/esign-rest-api/reference/Envelopes/EnvelopeRecipientTabs/update)
However when using the update method I need to have the tabId which is unique for each envelope. If I have 20 tabs in a document I have to fetch them all for getting the ID before doing an update. Is there a better way of doing this?
The API must be able to determine the unique tab you wish to update, so a unique ID of some sort is required to do so. Note also tabs are for a specific recipient and you need to specify the page number as well.
I'm trying to build a POC for our internal application using DocuSign, but I have some issues.
The flow is:
create a template in docuSign with a set of dynamic fields to be populated from the client app
the template has 2 recipients that have to sign the document - client and buyer with empty emails. The emails should be populated dynamically based on the order, so they're not fixed
from the client app, create an envelope that will use the template, will populate automatically the fields from the template and will open an embedded page where the first user(client) can sign the document immediately(without going to mail)
immediately after the client finished signing the document, an email should be sent to the second recipient(buyer) to finish the signing
For now, I succeed to implement all the steps, except the last one - the document is not sent automatically to the second recipient for signing.
How can I do that?
I know that I can use a recipients lists for sending email to receipts, but this is not possible when using a template - I get an error.
Thanks in advance!
Check that your template definition has the two recipient roles defined with different Signing order values.
The first recipient will have signing order 1, second signing order 2.
When you create the envelope from the template, you set the clientUserId for just the first signer. That way the second signer is a regular ("remote") email recipient.
If you'd like more help, please EDIT your question to show the code you use for creating the envelope from the template.
In docusign is it possible to create a signing request via the web interface and then retrieve the sigining URL via the API
at the moment, I update the Envelope using the API to attach a clientUserID as this is lacking when created via the web interface.
Then I retrieve the signing view url however, there is no signing tab when navigating to that url. The only action I have is to close.
I have tested using the API and the envelope contains signing tabs so I'm not sure what the issue would be.
Any help would be much appreciated!
When you send a DocuSign envelope if you assign one or more tabs to your recipient it becomes what's known as a Free Form signing experience, where the recipient decides where to sign the document.
On the other hand if you specify one or more tabs for the recipient then it's a Guided Signing experience. In guided signing the recipient can only sign and take actions at the tabs the sender has specified.
It sounds like you are successfully creating the envelope and signing URL but that there are no tabs configured for the signer. If that's the case you should confirm your code is identifying the recipient correctly by specifying the name, email, recipientId, and clientUserId values.
I would also check that the tabs are being set in your request body correctly for the given recipient. First get the recipient information for the envelope using the EnvelopeRecipients: list API to ensure the data is what you expect, then generate the signing URL using the corresponding data.
With reference to the below question -
Docusign API Multiple Embedded in Person Signers
InPerson Signer: Since the earlier question doesn't have an answer ticked.
From my webpage (C#, Asp.Net MVC), Once the documents are uploaded to Docusign, I want the whole document to be opened in a separate tab and with multiple signers. I am able to achieve this for a single inperson signer by mentioning the ClientUserId. If there are more than one inperson signer then how will the docusign works? On every Sign, does it give my web app a response and then do I need to call the next recipient View URL.
Help much appreciated.
The recipient View URL will provide you the URL to open the docusign document for the first signer. Once the recipient signs and clicks on FINISH, the response URL should contain the envelope ID as the query string parameter. Add a new Action method to accept the envelope id as query string parameter. Fetch the recipient list by using EnvelopesApi.ListRecipients method. Check the recepientList.CurrentOrder property which states the next person in the line to sign. Fetch the recipient view url of the next person and redirect to the new url again. Repeat this process until the CurrentOrder is null.