I have created a template in my DocuSign account. As the UI requires, I have uploaded a document.
I have been trying to create a transaction using this template, however, I need to add documents to this transaction, on top of the ones provided in the template.
Looking at the DocuSign Template documentation, it doesn't seem possible as it is mentioned : To apply a template to an envelope you must set the templateId and templateRoles properties in your envelope definition. Since the template contains document(s) already you do not need to configure the documents node.
Am I missing something ?
You can use composite templates and specify a new document in addition to the documents present in the server template.
{
"compositeTemplates": [
{
"compositeTemplateId": "1",
"serverTemplates": [
{
"sequence": "1",
"templateId": "<Specify the server template Id here>"
}
],
"inlineTemplates": [
{
"sequence": "1",
"recipients": {
"signers": [
{
"name": "Recipient One",
"email": "recipientone#foo.com",
"roleName": "Signer", //This is the role name in the server template
"recipientId": "1"
}
]
}
}
]
},
{
"compositeTemplateId": "2",
"inlineTemplates": [
{
"sequence": "2"
}
],
"document": {
"documentId": "3", //Make sure this documentId is different from the document's present in the server template.
"name": "DocumentThree",
"fileExtension": "txt",
"documentBase64": "RG9jIFRXTyBUV08gVFdP"
}
}
],
"emailSubject": "Adding a new doc with composite templates",
"status": "created"
}
Related
I am able to send a POST request to send an existing template for signing. What I'm trying to do now is attach a PDF to the signature template. The attached PDF does not need to be signed / is not a template. It is just a PDF copy of a document as an appendix to the contract.
The request is going through ok, but I'm getting the error: "TAB_PAGENUMBER_IS_NOT_IN_DOCUMENT",\r\n "message": "The pagenumber specified in the tab element is not in the document that the tab refers to. Tab on Page 8 of Document 1 for Recipient 1"
JSON:
{
"emailSubject": "Please sign this document set",
"templateId": "xxxxxxx",
"templateRoles": [
{
"email": "email#example.com",
"roleName": "Buyer",
"name": "Buyer Name"
}
],
"documents": [
{
"signerMustAcknowledge": "no_interaction",
"order": "asc",
"name": "MyCompany Quote",
"includeInDownload": true,
"documentId": "2",
"documentBase64": "<base64string>",
"display": "inline"
},
],
"status": "sent"
}
How to attach a document to an online template?
The error you are seeing is because DocuSign will try to replace the document in the template with the file you are providing.
You should be able to add this additional document by using composite templates instead. https://developers.docusign.com/docs/esign-rest-api/how-to/request-signature-composite-template-embedded/
Here is a sample:
{
"compositeTemplates": [
{
"compositeTemplateId": "1",
"inlineTemplates": [
{
"recipients": {
"signers": [
{
"email": "email#example.com",
"roleName": "Buyer",
"name": "Buyer Name"
}
]
},
"sequence": "1"
}
],
"serverTemplates": [
{
"sequence": "1",
"templateId": "xxxxxxx"
}
]
},
{
"compositeTemplateId": "2",
"document": {
"documentBase64": "<base64string>",
"documentId": "2",
"fileExtension": "pdf",
"name": "MyCompany Quote"
},
"inlineTemplates": [
{
"sequence": "1"
}
]
}
],
"emailSubject": "Please sign this document set",
"status": "sent"
}
The first composite template is used to populate your existing template with the signers information. The second composite template is where you add the additional document you want your users to sign. You can also include additional tabs inside the inlineTemplates if they are needed in the future
I have created a template via the DocuSign UI; that template contains some tabs for various roles.
I want to send a document via DocuSign REST API, in which the template (only the tabs e.g. signHere, initiateHere, Title etc) will apply.
I haven't added any recipient on the template. What I want to use from that template are only the tabs.
My JSON
{
"emailBlurb":"Test Email Body",
"emailSubject": "Test Email Subject",
"status" : "sent",
"compositeTemplates": [
{
"serverTemplates": [
{
"sequence" : 1,
"templateId": "c9e5adfa-d708-4467-a0ea-c615fa429a0f"
}],
"inlineTemplates": [
{
"sequence" : 2,
"recipients": {
"signers" : [{
"email": "nalam#relisource.com",
"name": "Noor",
"recipientId": "1",
"roleName": "Applicant"
}]
}
}],
"document": {
"documentId": 1,
"name": "test1.pdf",
"documentBase64":"Base64streamhere"
}
}]
}
It gives me the following error.
{
"errorCode": "INVALID_CONTENT_TYPE",
"message": "Content Type specified is not supported."
}
I am using POSTMAN. What is the problem here ?
Your documentBase64 attribute doesn't look right. Perhaps an error in copying it? Also, setting the fileExtension is highly recommended:
It should be
"document": {
...
"documentBase64": "Base64EncodedString",
"fileExtension": "pdf"
}
I suggest you use API request logging to see exactly what Postman is sending.
Template document substitution
If you're trying to substitute a document at runtime for the document in a server template, see the answers to this SO question for additional tips.
What you want here is the serverTemplate to be in sequence with the inlineTemplate so they need to have the same sequence number. Also you need another inline template to hold your document object. Something like this:
{
"emailBlurb":"Test Email Body",
"emailSubject": "Test Email Subject",
"status" : "sent",
"compositeTemplates": [
{
"serverTemplates": [
{
"sequence" : 1,
"templateId": "c9e5adfa-d708-4467-a0ea-c615fa429a0f"
}],
"inlineTemplates": [
{
"sequence" : 1,
"recipients": {
"signers" : [{
"email": "nalam#relisource.com",
"name": "Noor",
"recipientId": "1",
"roleName": "Applicant"
}]
}
}],
"inlineTemplates": [
{
"sequence" : 2
"document": {
"documentId": 1,
"name": "test1.pdf",
"documentBase64":"Base64streamhere"
}
}
}]
}
I'm using the DocuSign REST API to create an envelope from a template. My code works with single document templates or templates with multiple documents where only one document has tabs. If there are tabs on both documents I receive a 400 response with error code TAB_REFERS_TO_MISSING_DOCUMENT.
The response I receive is:
{
"error": "invalid HTTP response",
"message": {
"errorCode": "TAB_REFERS_TO_MISSING_DOCUMENT",
"message": "The DocumentId specified in the tab element does not refer to a document in this envelope. Tab refers to DocumentId 45159457 which is not present."
},
"status": 400,
"url": "https://demo.docusign.net/restapi/v2/accounts/2826983/envelopes/"
}
My request is as follows:
{
"status": "sent",
"templateId": "bb283bfb-4049-431d-942a-9a485e4ebb41",
"emailSubject": "[[Signer UserName]], please sign this document",
"documents": [
{
"documentId": "27069418",
"documentBase64": "...",
"name": "name.pdf"
},
{
"documentId": "45159457",
"documentBase64": "...",
"name": "secondName.pdf"
}
]
}
From what I've seen people receive this request when they submit invalid documentId's like 1 but the document that's "missing" is clearly attached. Am I missing something?
The final and working JSON request looks like so:
{
"status": "sent",
"emailSubject": "...",
"compositeTemplates": [{
"serverTemplates": [{
"sequence": 2,
"templateId": "..."
}],
"inlineTemplates": [{
"sequence": 1,
"documents": [{
"documentId": "...",
"name": "...",
"documentBase64": "..."
}, {
"documentId": "...",
"name": "...",
"documentBase64": "..."
}]
}]
}]
}
You can overcome the error using composite Templates. Specifying the new documents in an inlineTemplate with lower sequence number("sequence": "1") will ensure the inlineTemplate documents will replace the server template documents.
Here is a sample CreateEnvelope request.
{
"emailSubject": "[[Signer UserName]], please sign this document",
"status": "sent",
"compositeTemplates": [
{
"inlineTemplates": [
{
"sequence": "1",
"documents": [
{
"documentId": "27069418",
"name": "name.pdf",
"documentBase64": ""
},
{
"documentId": "45159457",
"name": "secondName.pdf",
"documentBase64": ""
}
]
}
],
"serverTemplates": [
{
"sequence": "2",
"templateId": "bb283bfb-4049-431d-942a-9a485e4ebb41"
}
]
}
]
}
To replace the document(s) in a template you must use composite templates instructions in your Envelopes: create call.
In your use case, you want to composite together the template and then a new document "in front" of the existing document in the template.
"Compositing templates" is like compositing together multiple pieces of film to produce a final print.
I am having an issue with understanding how inline templates work. I have 2 server templates and 2 inline templates, 1 inline template to marry up with a server template. I want to see if I don't fill in the info for the inline template that the envelope still works. Here is my request:
Request
{
"compositeTemplates": [
{
"serverTemplates": [
{
"sequence": "1",
"templateId": "8a3a21af-4348-45e1-85b9-72a331c9c67a"
}
],
"inlineTemplates": [
{
"sequence": "1",
"recipients": {
"signers": []
}
}
],
"document": {
"documentId": "2",
"name": "FinalSale.docx",
"fileExtension": "docx",
"documentBase64": [bytearray]
}
},
{
"serverTemplates": [
{
"sequence": "1",
"templateId": "d22048be-4bfe-43c2-9acf-3d5bcd79144f"
}
],
"inlineTemplates": [
{
"sequence": "1",
"recipients": {
"signers": [
{
"name": "Kathy Keaton",
"email": "KathyKeaton1#outlook.com",
"recipientId": "1",
"accessCode": "5000",
"routingOrder": "1",
"roleName": "##Buyer1"
},
{
"name": "Kathy Lloyd",
"email": "KathyLloyd1#outlook.com",
"recipientId": "2",
"accessCode": "5000",
"routingOrder": "2",
"roleName": "##Seller1"
}
]
}
}
],
"document": {
"documentId": "1",
"name": "Going to test out signatures and initials.docx",
"fileExtension": "docx",
"documentFields": [
{
"name": "dgsvalue",
"value": "dgs-222"
}
],
"documentBase64": [bytearray]
}
}
],
"status": "sent",
"emailSubject": "Please sign the following 2 documents at 2:39 PM"
}
Response
{
"envelopeId": "f8a090cf-ddc3-4612-8f24-9ff13beddc48",
"uri": "/envelopes/f8a090cf-ddc3-4612-8f24-9ff13beddc48",
"statusDateTime": "2017-02-01T19:39:26.2330000Z",
"status": "sent"
}
I was assuming that the inline templates would have to supply all the signers. The role names in the 2 templates are the same ( ##Buyer1 and ##Seller1 are in both templates ). I would have thought that not having the inline template filled in would mean that it would fail on that particular document. I was wrong, but I'm not sure why. Did it succeed because the role names are the same on both server templates and specifying it for one inline template was enough?
You are not required to supply all the signers in an inline template.
Here are the complete rules for Composite template usage.
Quoting some of them here.
Each CompositeTemplate adds a new document and templates overlay into
the envelope. For each CompositeTemplate these rules are applied:
Templates are overlaid in the order of their Sequence value.
If Document is not passed into the system, the first template’s
document (based on template’s Sequence value) is used.
Last in wins in all cases except for the document (i.e. envelope
information, recipient information, secure field information). This
was done to keep things simple. There is no special casing.
For example, if you want higher security on a tab, then that needs to be specified in the last template in which the tab is included. If you want higher security on a role recipient it needs to be in the last template in which that role recipient is specified.
Recipient matching is based on Recipient Role and Routing Order. If there are matches, the recipient information is merged together. A final pass is done on all CompositeTemplates, after all template overlays have been applied, to collapse recipients with the same email, username and routing order. This prevents having the same recipients at the same routing order.
This should be pretty simple. I have one composite template with 1 server template and 1 inline template with one signer. This is what the request looks like:
{
"compositeTemplates": [
{
"serverTemplates": [
{
"sequence": "1",
"templateId": "c6dc72a6-51ae-47c3-a55a-7923a247f97c "
}
],
"inlineTemplates": [
{
"sequence": "2",
"recipients": {
"signers": [
{
"name": "Kathy Keaton",
"email": "KathyKeaton1#outlook.com",
"recipientId": "1",
"routingOrder": "1",
"roleName": "##Buyer1"
}
]
}
}
],
"document": {
"documentId": "1",
"name": "Doc1ForBigTest.docx",
"fileExtension": "docx",
"documentBase64": [bytearray]
}
}
],
"status": "sent",
"emailSubject": "Please sign the following document at 10:21 AM"
}
I want to use my copy of this particular document instead of the one in the template, but I get the TAB error mentioned above. What am I doing wrong? Thanks for any help.
You will need to download your template and look at the documentId references. It is likely that at some point the Web interface was used to update the document in the template, causing the new document to be added and the old one deleted. This involved updating the tab documentId references to be updated to "2" or higher. Now, when you substitute your document, you are specifying documentId="1" and DocuSign doesn't find a document with ID of "2" to put the tabs on.