署名者を追加

パラメータ名

タイプ

必須

説明

envelopeId

string

true

封筒ID

signerInfos

array

true

署名者情報コレクション

businessId

string

false

開発者がカスタマイズする業務番号、長さ500

userEmail

string

true

署名者のメールアドレス

phoneNumber

object

false

SMS通知が必要な場合は必須項目です。countryCodeとnumberの両方を入力する必要があります。デフォルトは空です。

countryCode

string

false

国・地域の国際コード。「+」は不要です。

number

string

false

形式チェックは行いません。最大長は13桁です。

customizeSettings

object

false

カスタム構成

notificationSettings

object

false

通知に関するカスタム設定

customizeMessage

string

false

専用メッセージ通知、文字制限200

notificationLanguage

string

false

通知言語、デフォルトは英語

en-US 英語

zh-CN 中国語（簡体字）

zh-Hant 中国語（繁体字）

ja-JP 日本語

ES-MX スペイン語

userName

string

true

署名者の名前。署名ページとフローで署名者の名前を外部に表示するために使用します。

【注意】次の9つの特殊文字を含めることはできません：/ \ : * " < > | ？およびすべてのemoji

signOrder

int

true

署名者の署名順序。最小値は1です。順不同署名の場合は、同じ順序値を指定できます。

anySigner

boolean

false

いずれかの署名者が署名することをサポートするかどうか。デフォルトはfalseです

true-同じsignOrderでは、1人だけが署名すればよい

false-同じsignOrderでは、すべての人が署名する必要がある

authModes

string

false

本人確認方法。デフォルトはnoAuthです

列挙型：

authConfig

object

false

検証方法設定

accessCode

object

false

署名パスワード設定、authModes=accessCodeの場合必須

accessCode

string

false

パスワードの内容、大文字と小文字を区別せず、英数字を含めることができ、長さは45です

promptInfo

string

false

アクセスパスワードのヒント情報。アクセスパスワードを含めることはできません。長さ制限は30です。authModes=accessCodeの場合に必須。

sms

object

false

SMS OTP認証。authModes=smsの場合に必須

countryCode

string

false

国・地域の国際コード。「+」は不要

number

string

false

フォーマット検証は行いません。最大長は13桁です

idVerification

object

false

身分証明書検証設定、authModes=idVerificationの場合必須

name

string

false

署名者の身分証明書に記載されている氏名のフルネーム、最大長100文字

emailAuth

object

false

メールOTP検証、authModes=emailAuthの場合必須

authEmail

string

false

署名者の身元確認メールアドレス

digitalId

array

false

電子ID認証。authModes=digitalIdの場合に必須

authApp

string

false

電子ID認証に使用するAPP

singpass - Singpassを使用して認証

idNumber

string

false

署名者が検証待ちのID番号

digitalSignature

boolean

false

デジタル署名を有効にするかどうか。デフォルトはfalse

true-有効にする

false-無効

freeFormSign

boolean

false

署名者が自由に署名するかどうか、デフォルト値は false

補足説明：

freeFormSignをtrueに選択した場合、sealInfos下の他のパラメータを渡す必要はありません。同時に渡された場合、freeFormSignの優先順位はsealInfosよりも高く、sealInfos下のパラメータは有効になりません。

【注意】自由署名とは、署名者がドラッグできる印鑑/署名の数と位置を制限しないことです。

sealInfos

array

false

署名タスク情報

fileKey

string

true

署名ファイルfileKey

signConfigs

array

false

コントロールの位置情報。電子署名を行うには、コントロールの位置情報を指定する必要があります。

fieldType

string

false

コントロールタイプ、入力パラメータとして指定可能：

signature-署名コントロール

stamp-図章コントロール

デフォルトはsignature

sizeRule

string

false

署名エリアのサイズ表示方法

originalSize-署名/図章の実際のサイズで捺印

targetSize-署名/図章エリアの高さと幅をカスタマイズ

sizeRule、height、widthがすべて空の場合、署名/図章の実際のサイズで捺印します。

sizeRuleが空で、heightとwidthが空でない場合、指定されたサイズで捺印します。

sizeRuleが空でない場合、指定された表示方法で捺印します。

height

int

false

署名コントロールの高さ。fieldTypeがsignature/stampの場合に適用されます。単位はpxで、正の整数のみがサポートされます。デフォルトはauto（システム自動サイズ）です。

fieldType=signatureの場合、設定範囲は20〜250pxです。

fieldType=stampの場合、設定範囲は30〜280pxです

width

int

false

署名コントロールの幅。fieldTypeがsignature/stampの場合に適用されます。単位はpxで、正の整数のみがサポートされます。デフォルトはauto（システム自動サイズ）です。

fieldType=signatureの場合、設定範囲は20〜250pxです。

fieldType=stampの場合、設定範囲は30〜280pxです

signatureOptions

string

false

署名コントロールのオプション。fieldTypeがsignatureの場合のみ適用されます。

入力パラメータ：

template

handDrawn

upload

複数選択可能。「,」で区切ります。デフォルトはすべて選択

movable

boolean

false

署名時に位置の移動を許可します。デフォルトはfalse

false-署名者が自分の署名コントロールの位置を調整することを許可しません

true-署名者が自分の署名コントロールの位置を調整することを許可します

allowedOptions

array

false

署名者が承認できるオプション。fieldTypeがapprovalの場合に適用されます。デフォルトは["approve", "decline"]です。

approve-同意

decline-拒否

pageNo

string

false

署名ページ番号；連続ページ番号は"-"で接続し、個別のページ番号は","で接続します。例：1-3, 6-10

posX

string

false

X軸座標

補足説明：

fieldTypeがsignatureの場合、座標位置は署名エリアを指します左下；

fieldTypeがstampの場合、座標位置は捺印エリアを指します中心点位置

2026年2月3日より、fieldTypeがsignatureまたはstampの場合、その座標位置は捺印エリアの中心点を指します。

posY

string

false

Y軸座標

補足説明：

fieldTypeがsignatureの場合、座標位置は署名エリアを指します左下；

fieldTypeがstampの場合、座標位置は捺印エリアを指します中心点位置

2026年2月3日より、fieldTypeがsignatureまたはstampの場合、その座標位置は捺印エリアの中心点の位置を指します。

fillConfigs

array

false

記入コントロール情報

fieldName

string

false

コントロール名、文字数制限128

required

boolean

false

必須項目かどうか、デフォルトは必須

true-必須

false-任意

fieldType

string

false

コントロールタイプ：

1-一行テキスト

15-チェックボックス

textField

object

false

テキストコントロールの属性

overflowType

int

false

テキストにのみ有効、デフォルトは1

1-自動的にフォントサイズを縮小

2-入力を制限

minFontSize

float

false

テキストにのみ有効、overflowType=1の場合のみ有効、デフォルトは8。

5, 5.5, 6, 6.5, 7, 7.5, 8, 9, 10, 10.5, 11, 12, 14, 15, 16, 18, 20, 22, 24, 26, 28, 36, 42, 48, 56, 72

width

int

false

コントロールの幅、デフォルトは160px

font

int

false

textのみ有効、フォントはデフォルトで宋体。

1-宋体

2-新宋体

4-黒体

5-楷体

6-Arial

7-Helvetica

9-Times New Roman

10-仿宋

11-Georgia

12-Monospace

fontSize

float

false

textのみ有効、フォントサイズ、デフォルト12

5, 5.5, 6, 6.5, 7, 7.5, 8, 9, 10, 10.5, 11, 12, 14, 15, 16, 18, 20, 22, 24, 26, 28, 36, 42, 48, 56, 72

textColor

string

false

textのみ有効、16進数カラー、デフォルトは黒#000

bold

boolean

false

textのみ有効、フォントを太字にするかどうか、デフォルトはfalse

true-太字

false-太字にしない

italic

boolean

false

textのみに有効、斜体にするかどうか、デフォルトはfalse

true-斜体

false-斜体ではない

underline

boolean

false

textのみに有効、フォントに下線を追加するかどうか、デフォルトはfalse

true-下線を追加

false-下線を追加しない

lineThrough

boolean

false

textのみに有効、取り消し線を追加するかどうか、デフォルトはfalse

true-取り消し線を追加

false-取り消し線を追加しない

horizontalAlignment

string

false

textのみに有効、水平方向の配置、デフォルトはleft

LEFT-左寄せ

CENTER-中央

RIGHT-右寄せ

tickBoxField

object

false

チェックボックスの属性

tickOptions

array

false

Checkにのみ有効、デフォルトは1

1-チェック

2-バツ

posX

float

false

コントロール位置X横座標

posY

float

false

コントロール位置Y縦座標

pageNo

string

false

コントロールがあるページ番号

signDateConfigs

array

false

署名日位置情報

movable

boolean

false

署名時に位置の移動を許可するか、デフォルトはfalse

false-署名者が自分の署名コントロールの位置を調整することを許可しない

true-署名者が自分の署名コントロールの位置を調整できるようにする

pageNo

string

false

署名ページ番号；連続ページ番号は"-"で接続し、個別のページ番号は","で接続します。例：1-3, 6-10

連続していない場合は","で区切って渡します

posX

float

false

x軸オフセット、ページ左下隅を座標原点とする

posY

float

false

y軸オフセット、ページ左下隅を座標原点とする

signDateFormat

string

false

署名日の日付形式。デフォルトの形式はyyyy-MM-ddです。

指定可能な形式：

yyyy年MM月dd日

yyyy-MM-dd

yyyy/MM/dd

dd.MM.yyyy

MM dd yyyy

dd MM yyyy