Signatory data model

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

FieldTypeRequiredDescription
idstringNoUnique identifier for this signatory
created_atstring (date-time)NoThe date that this signatory was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
updated_atstring (date-time)NoThe last date that this signatory was updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
document_idstringNoParent signing document; points to SigningDocument
namestringNoFull name of the signatory
emailstringNoEmail address of the signatory
roleenumNoRole of the signatory Values: SIGNER, CC, APPROVER, IN_PERSON_SIGNER, VIEWER
statusenumNoCurrent status of this signatory Values: PENDING, SENT, DELIVERED, SIGNED, DECLINED, ERROR
ordernumberNoSigning order (1, 2, 3...)
signed_atstring (date-time)NoWhen this signatory signed (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
decline_reasonstringNoReason for declining (if status is DECLINED)

TypeScript

TypeScript
export type SigningSignatory = {
	id?: string; // Unique identifier for this signatory
	created_at?: string-time; // The date that this signatory was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
	updated_at?: string-time; // The last date that this signatory was updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
	document_id?: string; // Parent signing document; points to SigningDocument
	name?: string; // Full name of the signatory
	email?: string; // Email address of the signatory
	role?: 'SIGNER' | 'CC' | 'APPROVER' | 'IN_PERSON_SIGNER' | 'VIEWER'; // Role of the signatory
	status?: 'PENDING' | 'SENT' | 'DELIVERED' | 'SIGNED' | 'DECLINED' | 'ERROR'; // Current status of this signatory
	order?: number; // Signing order (1, 2, 3...)
	signed_at?: string-time; // When this signatory signed (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)
	decline_reason?: string; // Reason for declining (if status is DECLINED)
	raw?: any; // The raw data returned by the integration
} 

Zod

Zod
import { z } from 'zod';

export const ZodSigningSignatory = z.object({
	id: z.string().optional().describe("Unique identifier for this signatory"),
	created_at: z.string-time().optional().describe("The date that this signatory was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"),
	updated_at: z.string-time().optional().describe("The last date that this signatory was updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"),
	document_id: z.string().optional().describe("Parent signing document; points to SigningDocument"),
	name: z.string().optional().describe("Full name of the signatory"),
	email: z.string().optional().describe("Email address of the signatory"),
	role: z.enum("SIGNER", "CC", "APPROVER", "IN_PERSON_SIGNER", "VIEWER").optional().describe("Role of the signatory"),
	status: z.enum("PENDING", "SENT", "DELIVERED", "SIGNED", "DECLINED", "ERROR").optional().describe("Current status of this signatory"),
	order: z.number().optional().describe("Signing order (1, 2, 3...)"),
	signed_at: z.string-time().optional().describe("When this signatory signed (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"),
	decline_reason: z.string().optional().describe("Reason for declining (if status is DECLINED)"),

});

Python

Python
import dataclasses

@dataclasses.dataclass
class SigningSignatoryRole(str, Enum):
	SIGNER = 'SIGNER'
	CC = 'CC'
	APPROVER = 'APPROVER'
	IN_PERSON_SIGNER = 'IN_PERSON_SIGNER'
	VIEWER = 'VIEWER'

@dataclasses.dataclass
class SigningSignatoryStatus(str, Enum):
	PENDING = 'PENDING'
	SENT = 'SENT'
	DELIVERED = 'DELIVERED'
	SIGNED = 'SIGNED'
	DECLINED = 'DECLINED'
	ERROR = 'ERROR'

@dataclasses.dataclass
class SigningSignatory:
	"""Unique identifier for this signatory"""
	id: Optional[str]
	"""The date that this signatory was created (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"""
	created_at: Optional[str]
	"""The last date that this signatory was updated (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"""
	updated_at: Optional[str]
	"""Parent signing document; points to SigningDocument"""
	document_id: Optional[str]
	"""Full name of the signatory"""
	name: Optional[str]
	"""Email address of the signatory"""
	email: Optional[str]
	"""Role of the signatory"""
	role: Optional[SigningSignatoryRole]
	"""Current status of this signatory"""
	status: Optional[SigningSignatoryStatus]
	"""Signing order (1, 2, 3...)"""
	order: Optional[int]
	"""When this signatory signed (ISO-8601 / YYYY-MM-DDTHH:MM:SSZ format)"""
	signed_at: Optional[str]
	"""Reason for declining (if status is DECLINED)"""
	decline_reason: Optional[str]
Are we missing anything? Let us know
Was this page helpful?