DocuSign Envelope creation failed containing PDF fields transformation

Question

This is my JSON code so far:

{
  "status": "sent",
  "emailSubject": "This is an api Demo Doc, sent for signature",
  "recipients": {
    "carbonCopies": [
      {
        "email": "[email protected]",
        "name": "Nilashree",
        "recipientId": "2"
      }
    ],
    "signers": [
      {
        "email": "{{signer1Email}}",
        "name": "Nilashree Nandkumar shirodkar",
        "recipientId": "1"
      }
    ]
  },
  "compositeTemplates": [
    {
      "inlineTemplates": [
        {
          "sequence": "1",
          "recipients": {
            "signers": [
              {
                "email": "[email protected]",
                "name": "Nila Joseph",
                "recipientId": "1",
                "defaultRecipient": "true"
              }
            ]
          }
        }
      ],
      "documents": {
        "documentId": "1",
        "name": "application_form.pdf",
        "transformPdfFields": "true",
        "documentBase64": "{{}}"
      }
    }
  ]
}

But I am getting the following error:

"errorCode": "ENVELOPE_IS_INCOMPLETE",
"message": "The Envelope is not Complete. A Complete Envelope Requires Documents, Recipients, Tabs, and a Subject Line."

Can anyone please let me know what am I doing wrong?

Answer 1

Why are you using a composite template? Perhaps you are planning towards a later, more complicated envelope definition.

Your mistake is that each composite template can optionally contain only one document. The field name is document, not documents.

Instead of

  "documents": {
    "documentId": "1",
    "name": "application_form.pdf",
    "transformPdfFields": "true",
    "documentBase64": "{{}}"
  }

use

  "document": {
    "documentId": "1",
    "name": "application_form.pdf",
    "transformPdfFields": "true",
    "documentBase64": "{{}}"
  }

Also, I don't believe there's a need for the recipients outside of the composite templates structure. I'm not 100% sure about this issue though.