Skip to content

Errors

Invalid Included Document

A key in the deliverable's included_documents matches no document in the envelope. Use only document keys the envelope has.

What Happened

You called Create a deliverable with an included_documents value that is not the key of any document in the envelope. The detail property lists the keys the envelope has.

Example response

409 Conflict (application/problem+json)
{
  "type": "https://signatureapi.com/docs/v1/errors/invalid-included-document",
  "title": "Invalid Included Document",
  "status": 409,
  "detail": "Included document with key appendix is not part of the envelope. Available document keys: agreement, nda"
}

How to Fix

  • Compare each entry of included_documents with the document keys in the detail property. They are case-sensitive.
  • Read the envelope with Get envelope to see its document keys.
  • Remove included_documents to include every document.

  Still stuck? Contact support.