{
  "id": "doc_3jBYlxa9gv0fGLzFAnfwxe",
  "envelope_id": "52872f0e-b919-4d69-89cd-e7e56af00548",
  "title": "Dummy Agreement",
  "page_count": 2,
  "url": "https://pub-e5051420e98a4fdfb3fd42a62fbf06fa.r2.dev/dummy.docx",
  "format": "docx",
  "data": {
    "date": "December 31st, 2025",
    "show_alert": true,
    "service_provider": {
      "name": "Jane Smith",
      "organization": "ACME Global, Inc."
    },
    "client": {
      "name": "Michael J. Miller",
      "organization": "Miller Industries"
    }
  }
}

A document is a file within an envelope. It can be either a signable item, such as a contract, or for informational purposes only, like a cover letter. For now, documents have to be in PDF format.

A document belongs to an envelope.

​
Signature places

The places where the signatures go in a document are defined by special placemarks.

​
Attributes

id
string

The unique identifier of the document.

envelope_id
uuid

The unique identifier of the envelope.

title
string

The title of the document. It may be shown to recipients.

page_count
integer

The number of pages in the document.

url
string

The URL where the document or template is located must be publicly accessible and from a valid source.

format
enum

The format of the document or template.

Available options are pdf and docx.

data
object

The data to fill the template with.

{
  "id": "doc_3jBYlxa9gv0fGLzFAnfwxe",
  "envelope_id": "52872f0e-b919-4d69-89cd-e7e56af00548",
  "title": "Dummy Agreement",
  "page_count": 2,
  "url": "https://pub-e5051420e98a4fdfb3fd42a62fbf06fa.r2.dev/dummy.docx",
  "format": "docx",
  "data": {
    "date": "December 31st, 2025",
    "show_alert": true,
    "service_provider": {
      "name": "Jane Smith",
      "organization": "ACME Global, Inc."
    },
    "client": {
      "name": "Michael J. Miller",
      "organization": "Miller Industries"
    }
  }
}

Was this page helpful?

Resend requestSignature places