Document data model

View field support, webhooks, and list parameters for each integration on the Supported Integrations page.

FieldTypeRequiredDescription
idstringNoUnique identifier for this signing document
created_atstring (date-time)NoThe date that this signing document was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
updated_atstring (date-time)NoThe last date that this signing document was updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
namestringNoDocument/envelope title
descriptionstringNoMessage to signers
statusenumNoCurrent status of the signing document Values: DRAFT, SENT, DELIVERED, IN_PROGRESS, COMPLETED, DECLINED, VOIDED, EXPIRED
sent_atstring (date-time)NoWhen sent for signature (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
completed_atstring (date-time)NoWhen all signatures were collected (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
expires_atstring (date-time)NoSigning deadline (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
template_idstringNoIf created from a template; points to SigningTemplate
download_urlstringNoURL to download the signed document
creator_idstringNoUser who created the signing document

TypeScript

TypeScript
export type SigningDocument = {
	id?: string; // Unique identifier for this signing document
	created_at?: string-time; // The date that this signing document was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
	updated_at?: string-time; // The last date that this signing document was updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
	name?: string; // Document/envelope title
	description?: string; // Message to signers
	status?: 'DRAFT' | 'SENT' | 'DELIVERED' | 'IN_PROGRESS' | 'COMPLETED' | 'DECLINED' | 'VOIDED' | 'EXPIRED'; // Current status of the signing document
	sent_at?: string-time; // When sent for signature (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
	completed_at?: string-time; // When all signatures were collected (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
	expires_at?: string-time; // Signing deadline (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
	template_id?: string; // If created from a template; points to SigningTemplate
	download_url?: string; // URL to download the signed document
	creator_id?: string; // User who created the signing document
	raw?: any; // The raw data returned by the integration
} 

Zod

Zod
import { z } from 'zod';

export const ZodSigningDocument = z.object({
	id: z.string().optional().describe("Unique identifier for this signing document"),
	created_at: z.string-time().optional().describe("The date that this signing document was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"),
	updated_at: z.string-time().optional().describe("The last date that this signing document was updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"),
	name: z.string().optional().describe("Document/envelope title"),
	description: z.string().optional().describe("Message to signers"),
	status: z.enum("DRAFT", "SENT", "DELIVERED", "IN_PROGRESS", "COMPLETED", "DECLINED", "VOIDED", "EXPIRED").optional().describe("Current status of the signing document"),
	sent_at: z.string-time().optional().describe("When sent for signature (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"),
	completed_at: z.string-time().optional().describe("When all signatures were collected (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"),
	expires_at: z.string-time().optional().describe("Signing deadline (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"),
	template_id: z.string().optional().describe("If created from a template; points to SigningTemplate"),
	download_url: z.string().optional().describe("URL to download the signed document"),
	creator_id: z.string().optional().describe("User who created the signing document"),

});

Python

Python
import dataclasses

@dataclasses.dataclass
class SigningDocumentStatus(str, Enum):
	DRAFT = 'DRAFT'
	SENT = 'SENT'
	DELIVERED = 'DELIVERED'
	IN_PROGRESS = 'IN_PROGRESS'
	COMPLETED = 'COMPLETED'
	DECLINED = 'DECLINED'
	VOIDED = 'VOIDED'
	EXPIRED = 'EXPIRED'

@dataclasses.dataclass
class SigningDocument:
	"""Unique identifier for this signing document"""
	id: Optional[str]
	"""The date that this signing document was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"""
	created_at: Optional[str]
	"""The last date that this signing document was updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"""
	updated_at: Optional[str]
	"""Document/envelope title"""
	name: Optional[str]
	"""Message to signers"""
	description: Optional[str]
	"""Current status of the signing document"""
	status: Optional[SigningDocumentStatus]
	"""When sent for signature (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"""
	sent_at: Optional[str]
	"""When all signatures were collected (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"""
	completed_at: Optional[str]
	"""Signing deadline (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"""
	expires_at: Optional[str]
	"""If created from a template; points to SigningTemplate"""
	template_id: Optional[str]
	"""URL to download the signed document"""
	download_url: Optional[str]
	"""User who created the signing document"""
	creator_id: Optional[str]
Are we missing anything? Let us know
Was this page helpful?