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
Related
I am trying to include documents in my envelopes created via API that do not require signatures, but do require that only certain people see them.
I'm looking for a way to include these documents, keep them restricted to required parties. Any ideas? I'm still new to DocuSign API, so please let me know what other details I can share to help determine best course of action here.
Also, we are using C# for our APIs
Attempted to do this by having the people I need to see these documents as signers, but without the tags for where to sign and date. I am getting this error because we have the setting for "document visibility" set for this account, which is a requirement for this process.
*
"Error calling CreateEnvelope: {"errorCode":"ONESIGNALLSIGN_NOT_SATISFIED","message":"Freeform signing is not allowed for your account because it conflicts with other settings, please place signing tabs for each signer."}"*
Thanks!
For document visibility, each document needs at least on field (tab) placed on it. Whichever recipient the field belongs to will be able to see the document.
Plus, each signer recipient needs at least one tab or you're asking for free form signing, and that's not allowed with doc visibility.
The trick is that the field does not need to be a Sign here field. You could add a read-only (locked) text field. -- With no contents, so it would not be visible at all.
But at least one field per recipient is needed. If a doc has no fields then it is visible to all recipients.
Also, you can use confirmed cc recipients for people who won't sign but you want confirmation that they opened the envelope
See the docs
If you have more questions, ask a new stack overflow question
Sign at Docusign
As per the above thread, it is possible to retrieve Signing console URL for email recipients too by setting EmbeddedRecipientStartURL property to value "SIGN_AT_DOCUSIGN", As per the documentation(Sign at Docusign), below example has to be framed in order to open Docusign Signing console.
http://senderHost/[[mergeField1]]/beginSigningSession?[[mergeField2]]&[[mergeField3]]
Please explain what is senderHost & what should be filled in the mergeField properties accordingly? Let me know if you need any additional information related to this query.
BVS, I believe that's the opposite. If you provide EmbeddedRecipientStartURL field with SIGN_AT_DOCUSIGN, the signature will happen completely on DocuSign, and you don't have to provide any URL or merge fields.
If the value SIGN_AT_DOCUSIGN is used for this node, the recipient
will be directed to an embedded signing or viewing process directly at
DocuSign.
On the other hand, if you want to route the client through your own application BEFORE he or she goes to DocuSign, you could provide this kind of template URL with merge fields to better handle the request.
Information can be appended to the embeddedRecipientStartURL using
merge fields. The available merge fields items are: envelopeId,
recipientId, recipientName, recipientEmail, and customFields. The
customFields must be part of the recipient or envelope. The merge
fields are enclosed in double brackets.
By example: if you wanted to handle the request before the signer goes to DocuSign, you could send something like https://senderHost?envId=[[envelopeId]]&email=[[recipientEmail]]. Sender host is your host, so it can be anything on the internet (www.yoursite.com, by example).
Hope it helps!
I am using the Docusign-Connet to get the notifications form docusign. In docusign api there is a line
"It can also be used to transport the completed documents back to your app or website and to retrieve any form field data entered by your recipients"
but in payload I am getting only document names?.
If you want the connect messages to include the envelopes' documents or fields, check the boxes in the Connection Subscription screen (shown below from the New DocuSign Experience Admin tool).
Or set the fields includeDocumentFields and/or includeDocuments to true in your call to ConnectConfigurations: create
What i've done in the past is, get the document statuses from DocuSignConnect when things change. Then call EnvelopesApi.GetDocument endpoint with DocumentStatuses.DocumentStatus.ID and the envelope ID to retrieve the document.
In my implementation, we only download the document if the entire envelope is complete. This way, the DocuSignConnect payload is not big as well.
Btw, my implementation is in .net using their 2.1.9.0 library.
Good luck!
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.
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