I'm trying to download an unsigned envelope form a template.
The URL I'm hitting is https://demo.docusign.net/restapi/v2/accounts/{our account id}/envelopes/{envolopID}/documents/{documentId}. But this returns the empty template instead of the populated template. This seems to be the desired behavior but it looks like it is solvable. There isn't a clear explanation to how it was solved so I figured I'd ask again.
Are you using REST GET Documents to download docs from a DocuSign Envelope or Template? If from an envelope, you can enable the account setting in Features > Display SecureField initial value to all recipients. This will show the burned in initial values on the resulting PDF after the envelope is Sent. Downloading a Template's documents or a Draft (Created) Envelope's documents will not show these values. So if that is what you are trying to do, you'll want to get the tab values using the Get Tab Information for a Recipient call mentioned in the linked solution.
Related
I have a PowerForm with a text field that is pre populated via URL. I can see the field’s contents when signing. But when I look at the data received by the webhook, the text field and its value are not sent. I am using webhook.site for testing. Your ideas are welcome!
I’ve tried including the PowerForm in the webhook. Doesn’t make a difference either way. All I really want from the webhook is this one text field. I don’t even need the signer.
To get the value of a tab in a Connect publish, you'll need to go to the Include Data section and enable both Recipients and Tabs.
Docusign Provides a way to get tabs data for a single document in a template by specifying documentId. I could not find a way to get tabs data for all documents included in a template.
There's no data in templates, templates are not sent, or acted upon.
Only envelopes have data, and you mentioned you can get data from envelopes.
Now, maybe you meant how can I aggregate ALL the DATA from ALL envelopes created from a template.
If that's what you meant, then you may have to first find all these envelopes.
To do this, include some meta-data in your envelopes using custom fields. These will be used to later find them first, so that then you can get all the data from them using the search envelope endpoint (that can also return data).
If you're looking to see which tabs are placed on a template, you can do so by making a Templates::Get call with ?include=recipients,tabs.
As Inbar states, this won't get you any tab values (except one that are pre-populated by the template creator), as the template itself isn't what a signer interacts with - an envelope is sent that references the template. So if you're trying to collect data from your signers, you would need to be pulling tab data from an envelope instead.
Is it possible to get a PDF of the Envelope History that you can view from the DocuSign website when viewing the Envelope details and clicking on the More menu and selecting History:
which has the list of Activities that can be easily printed or saved as a PDF?
It looks like the listAuditEvents API endpoint returns the corresponding data but I was hoping to get this as PDF like on the History page as well. Is this one of the Documents that can be downloaded for an Envelope?
Is it possible to get a PDF of the Envelope History that you can view from the DocuSign website when viewing the Envelope details and clicking on the More menu and selecting History
No. But you just need to use the API call you noted, then create a PDF from the response data using one of the many PDF libraries available.
I am new to DocuSign, have made the tutorials and read through the DocuSign API documentation. I am developing in Java, and have successfully achieved to send documents for signing from a template to an email address. The document then gets opened, a custom field gets filled out. The document gets signed by the user.
Well now here are two questions that arise for me:
1) Am I right with the assumption that custom fields are to be used for virtually any form field like "Which pets do you have?" that a user is expected to fill out? Almost all the other fields which I can add when creating a template are being filled out automatically by DocuSign.
2) I have added a name and surname field as well as a custom field and the "sign here" field to the template from which I am sending the document via the API. Once the recipient has has filled out the information and signed the document, I would like to request the information which the user has entered into the custom field. How can I do that? I have found various requests for getting the status of a document or envelope. But never found how I can retrieve the actual user input.
Regards
Josef
In DocuSign if you have common tabs that you use for your recipients in your requests then you can use the Custom Fields to create them once then re-use them in your subsequent requests. However, in general if you want to have editable fields where you will gather info from your recipients then you can use the Text field and un-check read-only. If setting through the API it would look like this:
"textTabs": [
{
"tabLabel": "NameOfTheTab",
"value": "12345"
}
You can read more about using these fields through the Features section of the DocuSign Developer Center.
With regards to your second question of how to retrieve the data that your recipients fill out, remember that tabs are always specific to recipients (as opposed to the documents themselves) so take a look at the Get Tab Information for Recipient API call.
Example:
GET https://{server}/restapi/{apiVersion}/accounts/{accountId}/envelopes/{envelopeId}/recipients/{recipientId}/tabs
I want to make sure I am on the right track as I have been having some problems getting started with the API. I am looking to maintain a list of product application PDFs as templates on docusign. When a customer comes to our site and wants a particular product they need to fill out an application form. All the data would be collected on our site. I would then want to:
Create an envolope with the customer (and potentially other parties) that need to sign the document
Fill in the form fields from data collected on our site
Send the envelope out for signature and monitor the progress.
So in doing this I am trying to build this up a piece at a time and first task is to make sure that I can provide form data to docusign. I create a template with the docusign web user interface and all of the form fields seem to be preserved. However when I try and retrieve the template with API
https://demo.docusign.net/restapi/v2/accounts/xxxx/templates/yyyy
I see a very short response with an envelopeTemplateDefinition showing the correct name for the template but no documents object and no custom fields object. I have also tried this by creating an envelope with the document (in draft) but with similar results.
My apologies in advance for this newbie question.
I've repro'd the issue you describe -- i.e., the Response I get from a GET Template request contains only very limited information and is thereby not consistent with the expected Response as documented on pages 194-196 of the DocuSign REST API guide (http://www.docusign.com/sites/default/files/REST_API_Guide_v2.pdf). Not sure if this is a bug with the GET Template operation or with the Documentation -- someone at DocuSign will need to confirm (#Ergin).
In light of this limitation with the GET Template operation, you can alternatively retrieve the recipient information (including tabs) and document information about a Template by using the GET Envelope Recipients and GET Envelope Documents operations -- just specify the TEMPLATE Id in place of the Envelope Id, as shown here:
GET https://{{env}}.docusign.net/restapi/{{version}}/accounts/{{acctId}}/envelopes/{templateId}/documents
GET https://{{env}}.docusign.net/restapi/{{version}}/accounts/{{acctId}}/envelopes/{templateId}/recipients?include_tabs=true