{
"id": "55072f0e-b919-4d69-89cd-e7e56af00530",
"title": "Dummy Agreement",
"label": "Dummy Agreement for Order Ref. 25005",
"message": "Please review the agreement at your convenience and provide your electronic signature.",
"status": "completed",
"mode": "live",
"routing": "sequential",
"language": "en",
"timezone": "UTC",
"timestamp_format": "DD/MM/YYYY HH:mm:ss",
"sender": {
"name": "Jennifer Lee",
"email": "jennifer@example.com",
"organization": "Acme Enterprises"
},
"topics": [
"sales",
"project_blue"
],
"metadata": {
"customer_ref": "x9550501",
"account_annual_revenue": "$4,500,000"
},
"documents": [
{
"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",
"showAlert": true,
"serviceProvider": {
"name": "Jane Smith",
"organization": "ACME Global, Inc."
},
"client": {
"name": "Michael J. Miller",
"organization": "Miller Industries"
}
},
"places" : [
{
"key": "provider_signs_here",
"type": "signature",
"recipient_key": "service_provider"
},
{
"key": "client_signs_here",
"type": "signature",
"recipient_key": "client"
}
]
}
],
"recipients": [
{
"id": "re_26w2VVV5JVm4j459TY5BNM",
"envelope_id": "52872f0e-b919-4d69-89cd-e7e56af00548",
"type": "signer",
"key": "provider",
"name": "Emily Johnson",
"email": "emily@example.com",
"status": "completed",
"ceremony_creation": "automatic",
"delivery_type": "email",
"signature_options": ["typed", "drawn"],
"completed_at": "2025-12-31T15:00:00.000Z",
"status_updated_at": "2025-12-31T15:00:00.000Z"
},
{
"id": "re_38UVwrWdCqX5kqeKFJUTtf",
"envelope_id": "52872f0e-b919-4d69-89cd-e7e56af00548",
"type": "signer",
"key": "client",
"name": "Michael Taylor",
"email": "michael@example.com",
"status": "completed",
"ceremony_creation": "automatic",
"delivery_type": "email",
"signature_options": ["typed", "drawn"],
"completed_at": "2025-12-31T14:00:00.000Z",
"status_updated_at": "2025-12-31T14:00:00.000Z"
}
],
"deliverable": {
"id": "del_1T7If8GgrTOf7zBVPaJf2e",
"envelope_id": "52872f0e-b919-4d69-89cd-e7e56af00548",
"status": "generated",
"type": "audit_log",
"url": "https://s3.us-east-2.amazonaws.com/signatureapi-vault-dev/envelopes/52872f0e...",
"language": "en",
"timezone": "America/New_York",
"timestamp_format": "MM/DD/YYYY HH:mm:ss"
},
"created_at": "2025-12-31T12:00:00.000Z",
"completed_at": "2025-12-31T15:00:00.000Z"
}
{
"id": "55072f0e-b919-4d69-89cd-e7e56af00530",
"title": "Dummy Agreement",
"label": "Dummy Agreement for Order Ref. 25005",
"message": "Please review the agreement at your convenience and provide your electronic signature.",
"status": "completed",
"mode": "live",
"routing": "sequential",
"language": "en",
"timezone": "UTC",
"timestamp_format": "DD/MM/YYYY HH:mm:ss",
"sender": {
"name": "Jennifer Lee",
"email": "jennifer@example.com",
"organization": "Acme Enterprises"
},
"topics": [
"sales",
"project_blue"
],
"metadata": {
"customer_ref": "x9550501",
"account_annual_revenue": "$4,500,000"
},
"documents": [
{
"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",
"showAlert": true,
"serviceProvider": {
"name": "Jane Smith",
"organization": "ACME Global, Inc."
},
"client": {
"name": "Michael J. Miller",
"organization": "Miller Industries"
}
},
"places" : [
{
"key": "provider_signs_here",
"type": "signature",
"recipient_key": "service_provider"
},
{
"key": "client_signs_here",
"type": "signature",
"recipient_key": "client"
}
]
}
],
"recipients": [
{
"id": "re_26w2VVV5JVm4j459TY5BNM",
"envelope_id": "52872f0e-b919-4d69-89cd-e7e56af00548",
"type": "signer",
"key": "provider",
"name": "Emily Johnson",
"email": "emily@example.com",
"status": "completed",
"ceremony_creation": "automatic",
"delivery_type": "email",
"signature_options": ["typed", "drawn"],
"completed_at": "2025-12-31T15:00:00.000Z",
"status_updated_at": "2025-12-31T15:00:00.000Z"
},
{
"id": "re_38UVwrWdCqX5kqeKFJUTtf",
"envelope_id": "52872f0e-b919-4d69-89cd-e7e56af00548",
"type": "signer",
"key": "client",
"name": "Michael Taylor",
"email": "michael@example.com",
"status": "completed",
"ceremony_creation": "automatic",
"delivery_type": "email",
"signature_options": ["typed", "drawn"],
"completed_at": "2025-12-31T14:00:00.000Z",
"status_updated_at": "2025-12-31T14:00:00.000Z"
}
],
"deliverable": {
"id": "del_1T7If8GgrTOf7zBVPaJf2e",
"envelope_id": "52872f0e-b919-4d69-89cd-e7e56af00548",
"status": "generated",
"type": "audit_log",
"url": "https://s3.us-east-2.amazonaws.com/signatureapi-vault-dev/envelopes/52872f0e...",
"language": "en",
"timezone": "America/New_York",
"timestamp_format": "MM/DD/YYYY HH:mm:ss"
},
"created_at": "2025-12-31T12:00:00.000Z",
"completed_at": "2025-12-31T15:00:00.000Z"
}
label
property to add an internal description that won’t be shown to recipients.draft
, processing
, in_progress
, completed
, failed
, canceled
live
, test
parallel
, where all recipients can sign simultaneously, or sequential
, where recipients sign one after another. The default is parallel
.Learn more about Recipient Routingen
(English).Show PDF Document
pdf
and docx
.For PDF documents the format is pdf
.Show fixed position
Show signature place
recipient_key
, needs to sign.signature
.Show initials place
recipient_key
, needs to write their initials.initials
.Show text place
text
.#000000
(black).Show text input place
text_input
.captures
object of the Envelope.required
or optional
. The default is required
.email
or zipcode-us
. Alternatively, a regular expression can be used, enclosed in forward slashes.Learn more in Format Validation.Show checkbox place
checkbox
.captures
object of the Envelope.check
and xmark
. The default is check
.required
or optional
. The default is optional
.Show recipient completed date place
recipient_key
, completed (for example, signed) the envelope.recipient_completed_date
.D MMM YYYY
, which outputs as 31 Dec 2025.Show envelope completed date place
envelope_completed_date
.D MMM YYYY
, which outputs as 31 Dec 2025.Show DOCX Document
pdf
and docx
.For DOCX documents the format is docx
.Show fixed position
Show signature place
recipient_key
, needs to sign.signature
.Show initials place
recipient_key
, needs to write their initials.initials
.Show text place
text
.#000000
(black).Show text input place
text_input
.captures
object of the Envelope.required
or optional
. The default is required
.email
or zipcode-us
. Alternatively, a regular expression can be used, enclosed in forward slashes.Learn more in Format Validation.Show checkbox place
checkbox
.captures
object of the Envelope.check
and xmark
. The default is check
.required
or optional
. The default is optional
.Show recipient completed date place
recipient_key
, completed (for example, signed) the envelope.recipient_completed_date
.D MMM YYYY
, which outputs as 31 Dec 2025.Show envelope completed date place
envelope_completed_date
.D MMM YYYY
, which outputs as 31 Dec 2025.Show Signer
signer
(we will add more recipient types soon).For signers, the type is signer
.pending
, sent
, completed
, rejected
, soft_bounced
, hard_bounced
, failed
, and
replaced
.automatic
and manual
. The default is automatic
.email
and none
. The default is email
.To be able to set the delivery_type
to none
, please contact support.typed
and drawn
. The default value for this property is ["typed", "drawn"]
.null
until the envelope has been completed.Show Audit Log
audit_log
processing
, generated
, and failed
.{
"id": "55072f0e-b919-4d69-89cd-e7e56af00530",
"title": "Dummy Agreement",
"label": "Dummy Agreement for Order Ref. 25005",
"message": "Please review the agreement at your convenience and provide your electronic signature.",
"status": "completed",
"mode": "live",
"routing": "sequential",
"language": "en",
"timezone": "UTC",
"timestamp_format": "DD/MM/YYYY HH:mm:ss",
"sender": {
"name": "Jennifer Lee",
"email": "jennifer@example.com",
"organization": "Acme Enterprises"
},
"topics": [
"sales",
"project_blue"
],
"metadata": {
"customer_ref": "x9550501",
"account_annual_revenue": "$4,500,000"
},
"documents": [
{
"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",
"showAlert": true,
"serviceProvider": {
"name": "Jane Smith",
"organization": "ACME Global, Inc."
},
"client": {
"name": "Michael J. Miller",
"organization": "Miller Industries"
}
},
"places" : [
{
"key": "provider_signs_here",
"type": "signature",
"recipient_key": "service_provider"
},
{
"key": "client_signs_here",
"type": "signature",
"recipient_key": "client"
}
]
}
],
"recipients": [
{
"id": "re_26w2VVV5JVm4j459TY5BNM",
"envelope_id": "52872f0e-b919-4d69-89cd-e7e56af00548",
"type": "signer",
"key": "provider",
"name": "Emily Johnson",
"email": "emily@example.com",
"status": "completed",
"ceremony_creation": "automatic",
"delivery_type": "email",
"signature_options": ["typed", "drawn"],
"completed_at": "2025-12-31T15:00:00.000Z",
"status_updated_at": "2025-12-31T15:00:00.000Z"
},
{
"id": "re_38UVwrWdCqX5kqeKFJUTtf",
"envelope_id": "52872f0e-b919-4d69-89cd-e7e56af00548",
"type": "signer",
"key": "client",
"name": "Michael Taylor",
"email": "michael@example.com",
"status": "completed",
"ceremony_creation": "automatic",
"delivery_type": "email",
"signature_options": ["typed", "drawn"],
"completed_at": "2025-12-31T14:00:00.000Z",
"status_updated_at": "2025-12-31T14:00:00.000Z"
}
],
"deliverable": {
"id": "del_1T7If8GgrTOf7zBVPaJf2e",
"envelope_id": "52872f0e-b919-4d69-89cd-e7e56af00548",
"status": "generated",
"type": "audit_log",
"url": "https://s3.us-east-2.amazonaws.com/signatureapi-vault-dev/envelopes/52872f0e...",
"language": "en",
"timezone": "America/New_York",
"timestamp_format": "MM/DD/YYYY HH:mm:ss"
},
"created_at": "2025-12-31T12:00:00.000Z",
"completed_at": "2025-12-31T15:00:00.000Z"
}