署名者の追加

パラメータ名

型

必須

説明

envelopeId

string

true

封筒ID

signerInfos

array

true

署名者情報コレクション

businessId

string

false

開発者がカスタムするビジネス番号、長さ500

roleTypes

array

false

署名者の操作方式、デフォルト値は ["sign", "fill"]

fill-記入

sign-署名

string

false

userEmail

string

false

署名者のメールアドレス

documentVisibility

object

false

ファイルの可視性設定。デフォルトはすべて表示されます。

documentViewType

string

false

表示ポリシー。デフォルトは all です。all は封筒内のすべての署名ファイルを表示可能、limited は自身の署名ファイルと追加で表示可能なファイルのみを表示可能を示します。

viewableFileKeys

array

false

署名者に追加で表示を許可する fileKey のリスト。documentViewType=limited の場合に限り、入力して有効になります。

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 スペイン語（メキシコ）

pt-PT ポルトガル語
th-TH タイ語
id-ID インドネシア語
vi-VN ベトナム語
ms-MY マレー語
fil-PH フィリピン語
de-DE ドイツ語
fr-FR フランス語
ru-RU ロシア語
it-IT イタリア語
ko-KR 韓国語

userName

string

true

署名者の氏名。署名ページおよびプロセスで外部に表示される署名者の名前です。

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

signOrder

int

true

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

signTaskSuspend

boolean

false

この署名位置の前にプロセスブロックノードを設定するかどうか。デフォルトは false です。true-ブロックノードを設定；false-ブロックノードを設定しない。同じ signOrder の OR 署名グループ内では、ブロック設定が一致している必要があります。

suspensionKey

string

false

ブロックノードの識別子。最大500文字まで。同じ封筒内で一意である必要があります。signTaskSuspend=true の場合必須；signTaskSuspend=false または未指定の場合は入力不可。

suspendReason

string

false

ブロック理由。入力時は空であってはならず、最大50文字まで。signTaskSuspend=true の場合のみ入力可能；未入力の場合、外部システムの処理を待機することを意味します。signTaskSuspend=false または未指定の場合は入力不可。

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

電子認証、authModes=digitalIdの場合必須

authApp

string

false

電子認証に使用されるアプリ

singpass-Singpassを使用した本人認証

iamsmart-智方便（SmartID）を使用した本人認証

idNumber

string

false

署名者が検証対象とする身分証明書の番号

authApp=singpassの場合、入力規則は：大文字アルファベット＋7桁または8桁の数字＋大文字アルファベット

authApp=iamsmartの場合、入力規則は：

1. シーケンスの先頭として、大文字アルファベット1文字（A-Z）または2文字（AA-ZZ）；

2. その後に6桁の数字；

3. 最後にチェックディジット（数字0-9または大文字アルファベットA-Z）。例：A888888(A)

whatsappAuth

object

false

WhatsApp OTP認証、authModes=whatsappAuthの場合必須

countryCode

string

false

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

number

string

false

フォーマット検証は行わず、最大長を13桁に制限するのみ

digitalSignature

boolean

false

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

true-有効化

false-無効化

tsp

string

false

署名者が使用するTSPを選択します。デフォルトはfalse。

未設定の場合、署名者が使用するTSPを自由に選択できます。列挙値には以下が含まれます：

vinotek、eSignPersonal、localCertificates、iAmSmart、vnptSmartCa、adacomOneShot、audkenni

belgianIdCard、certEuropeUsbToken、certSignWebSign、chaveMovel、croatianIdCard、czechIdCard、dTrustSignMe、diia

estonianIdCard、estonianMobileId、evrotrust、finnishIdCard、frejaEid、frejaEidSign、gseGestionDeSeguridadElectronica、halcom

harica、idAustriaATrustSignatur、infoCert、ltId、latvianIdCard、latvianEParakstsMobile、lithuanianIdCard、lithuanianMobileId

mscTrustGate、mitId、norwegianBankId、oneId、pscWorldWallet、spid、serproId、simplySign

smartId、swedenBankId、swissId、swisscom、transSped、trustAsia、zealidApp、certMe

certSignUsbToken、eCertChile、eMudhra、itsme、mojeId、emdha

freeFormSign

boolean

false

署名者が自由な形で印章を押印できるかどうか。デフォルト値はfalse

補足説明：

freeFormSignがtrueに設定されている場合、sealInfos内の他のパラメータは入力不要です。両方を同時に指定した場合、freeFormSignの優先度が高く、sealInfos内のパラメータは無効になります。

【注意】自由な印章押印とは、署名者がドラッグ＆ドロップで配置できる印章/署名の数と位置に制限がないことを意味します。

sealInfos

array

false

署名タスク情報

fileKey

string

true

署名対象ファイルのfileKey

signConfigs

array

false

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

fieldType

string

false

コントロールタイプ。指定可能な値：

signature-署名コントロール

stamp-図章コントロール

デフォルトはsignature

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

true-必須

false-任意

signFieldStyle

string

false

署名コントロールの押印方法。デフォルトはnormalSeal。

normalSeal-通常印影

pagingSeal-ページ跨ぎ印影

ページ跨ぎ印影の設定は署名コントロールと図章コントロールのみサポートされます。

pagingSealMode

string

false

ページ跨ぎ印影の対象ページ範囲。デフォルトはall。

all-全ページ番号

assignedPages-指定ページ番号

even-偶数ページ

odd-奇数ページ

signFieldStyle=pagingSeal の場合のみ指定可能。

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

aiHandDrawn

複数選択可、カンマ（","）で区切る。デフォルトは全選択。

movable

boolean

false

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

false- 署名者が自身の署名コントロールの位置を調整することはできません。

true- 署名者が自身の署名コントロールの位置を調整することができます。

allowedOptions

array

false

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

approve- 同意

decline- 拒否

pageNo

string

false

署名ページ番号。連続するページ番号はハイフン（"-"）で連結し、個別のページ番号はカンマ（","）で連結します。例：1-3, 6-10

pagingSealMode=assignedPages の場合、騎縫印を押すページ範囲を指定します。騎縫印は2ページ以上のファイルにのみ使用できます。

posX

string

false

X座標

補足説明：

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

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

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

騎縫章には0を設定可能ですがnullは設定不可です。コントロールはファイルの右端に固定されます。

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-1行テキスト

15-チェックボックス

textField

object

false

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

overflowType

int

false

textにのみ適用、デフォルト1

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

2-入力を制限

minFontSize

float

false

textにのみ適用、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