ホーム/Sign（電子署名）/データ構造

Sign データ構造

Sign API で返却される主要オブジェクトのフィールド定義です。

ID 形式

各リソースは prefix 付き public ID（例: deal_..., inv_..., form_..., ak_...）を利用します。

Document object

電子署名の契約書を表すオブジェクトです。

フィールド

名前	型	必須	説明
id	string	必須	契約書 ID
object	string	必須	オブジェクト種別（`sign.document`）
organization_id	string	必須	組織 ID
title	string	必須	タイトル
status	"draft" \| "sent" \| "signed" \| "cancelled" \| "expired"	必須	ステータス（draft: 下書き、sent: 送信済、signed: 署名完了、cancelled: キャンセル、expired: 期限切れ）
created_by	string	必須	作成者 ID
sent_at	string \| null	任意	送信日時
signed_at	string \| null	任意	署名完了日時
created_at	string	必須	作成日時 (ISO 8601)
updated_at	string	必須	更新日時 (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

契約書の署名者を表すオブジェクトです。

フィールド

名前	型	必須	説明
id	string	必須	署名者 ID
object	string	必須	オブジェクト種別（`sign.signer`）
document_id	string	必須	契約書 ID
name	string	必須	署名者名
email	string	必須	メールアドレス
status	"pending" \| "signed" \| "declined"	必須	署名ステータス
signed_at	string \| null	任意	署名日時

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