Home/Sign/Data Structures

Sign Data Structures

Field definitions for key objects returned by Sign APIs.

ID Format

Resources use prefixed public IDs (for example deal_..., inv_..., form_..., ak_...).

Document object

Object representing an electronic signature document.

Fields

Name	Type	Required	Description
id	string	Required	Document ID
object	string	Required	Object type (`sign.document`)
organization_id	string	Required	Organization ID
title	string	Required	Title
status	"draft" \| "sent" \| "signed" \| "cancelled" \| "expired"	Required	Status (draft, sent, signed, cancelled, expired)
created_by	string	Required	Creator ID
sent_at	string \| null	Optional	Sent at
signed_at	string \| null	Optional	Signed at
created_at	string	Required	Created at (ISO 8601)
updated_at	string	Required	Updated at (ISO 8601)

{
  "id": "sdoc_01JQ3KXYZ",
  "object": "sign.document",
  "organization_id": "org_01HZXYZ",
  "title": "Service Agreement - Acme Corp",
  "status": "sent",
  "created_by": "usr_01HZABC",
  "sent_at": "2026-02-18T10:00:00Z",
  "signed_at": null,
  "created_at": "2026-02-17T14:00:00Z",
  "updated_at": "2026-02-18T10:00:00Z"
}

Signer object

Object representing a document signer.

Fields

Name	Type	Required	Description
id	string	Required	Signer ID
object	string	Required	Object type (`sign.signer`)
document_id	string	Required	Document ID
name	string	Required	Signer name
email	string	Required	Email
status	"pending" \| "signed" \| "declined"	Required	Signing status
signed_at	string \| null	Optional	Signed at

{
  "id": "signer_01JQ3KABC",
  "object": "sign.signer",
  "document_id": "sdoc_01JQ3KXYZ",
  "name": "Yamada Ichiro",
  "email": "yamada@acme.example.com",
  "status": "pending",
  "signed_at": null
}