Best way to extract specific document from envelope

Thank you Byungjae for the detailed response! It’s great to hear I can save the calls by providing documentFields directly in the createEnevelope call itself. Do you know if this is supported if I am creating the compositeTemplate from a serverTemplate instead of providing the document itself? I am not currently utilizing the document field of the compositeTemplate.

For example, my composite template for the document that needs to be identified looks as follows:

{
   serverTemplates: [
   {
      sequence: <>,
      templateId: <>,
      templateRoles: <>
   }],
   inlineTemplates: [
      {
         sequence: <>,
         recipients: {
            signers: [<>]
         }
      }
   ]
}

```

Update: I did some testing and specifying just the document_fields without a document doesn’t seem to work in the envelope:Create API. Below is the payload I sent:

{
  "compositeTemplates": [
      {
          "documents": [
              {
                  "documentFields": [
                      {
                          "name": "document_name",
                          "value": "<my_document_name>"
                      }
                  ]
              }
          ],
          "serverTemplates": [
              {
                  "sequence": "1",
                  "templateId": "<my_template_id>"
              }
          ],
          "inlineTemplates": [
              {
                  "sequence": 1,
                  "recipients": {
                      "signers": [
                          {
                              "email": "<my_email_adress>",
                              "name": "<my_name>",
                              "recipientId": "1",
                              "roleName": "<my_role>"
                          }
                      ]
                  }
              }
          ]
      }
  ],
  "emailSubject": "<my_email_subject>",
  "emailBlurb": "<my_email_blurb>",
  "status": "sent"
}

I have a requirement to use the server template for the document rather than using the document field in the compositeTemplate. if it is not possible to specify `documentFields` in a composite template creation, I could leverage the server templateId which is readily available to me.

I see that after creating the envelope, I can use the EnvelopeTemplates:list API, but would it be possible to include the server templateId (if one exists) in the GetEnvelope API call? Maybe something like include=documents,document_templates?

The GetEnvelope API documentation doesn’t include this, but it also didn’t include documentFields so I am wondering if there is an unofficial query param I can pass. The reason why I ask is because we already issue a GetEnvelope API call, so including the server templateIds there would avoid having to issue an additional call to EnvelopTemplates:list.

As you noticed, you need to define the document if you want to specify the document_fields.

but would it be possible to include the server templateId (if one exists) in the GetEnvelope API call? Maybe something like include=documents,document_templates?

Unfortunately, GetEnvelope API doesn't return the template information applied to the envelope. You would need to call the EnvelopeTemplates:list API additionally to get the list of the templates.

Thanks for all the help. I think we will go with the EnvelopeTemplates:list approach and use the known templateId to extract the documentId.

A final question on this topic: are documentIds assigned sequentially with respect to the order in which the compositeTemplates are provided in the request in createEnvelope? The document I am looking to download is always the last one in the request array so I am wondering if Docusign guarantees the order and I can just use the largest documentId for the download.

are documentIds assigned sequentially with respect to the order in which the compositeTemplates are provided in the request in createEnvelope?

Yes, your understanding is correct. However, it is not guaranteed. To avoid an unexpected update or change, you should refer to the document using documentFields.

Thanks Byungjae. Based on this discussion, we will go with the EnvelopeTemplates:list to identify the correct documentId for download.