クイックエンベロープの開始

パラメータ名

型

必須

説明

subject

string

true

エンベロープの件名

例：「Offer Letter」

remark

string

false

エンベロープのメモ、文字数制限1000字

signerSettings

object

false

署名者が実行可能な操作

allowTransfer

boolean

false

署名者にこの封筒を他の人に渡して署名させることを許可するかどうか。デフォルトは false

true - 封筒内の署名者が封筒を他人に譲渡する権限を持つことを許可します。

false - 封筒内の署名者が封筒を他人に譲渡する権限を持たないことを許可しません。

allowModifyName

boolean

false

署名者の氏名の変更を許可するかどうか。テンプレート署名にのみ有効で、デフォルトは false

true - 署名者の氏名の変更を許可します

false - 署名者の氏名の変更を許可しません

expireAfterSeconds

long

false

封筒の有効期限切れ時間。指定された秒数経過すると封筒が期限切れになります

有効期限の範囲：86,400秒（1日）〜7,776,000秒（90日）

redirectUrl

string

false

有効な https アドレスである必要があります

callBackUrl

string

false

コールバックアドレス（最大500文字）。https プロトコルのアドレスである必要があります。

sendLaterAfterSeconds

long

false

ユーザーによる送信遅延をサポート。単位は秒

サポートされる時間の範囲：3600秒（1時間）〜259200秒（30日）

autoFinish

boolean

false

封筒が自動的に終了するかどうかを制御。デフォルトは true

true- 封筒が自動的に終了

false- 封筒が手動で終了

CCInfos

array

false

CC情報コレクション

userEmail

string

false

CCのメールアドレス

userName

string

false

CCの名前。署名ページおよび封筒で外部に表示されるCCの名前に使用されます。

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

ccOrder

int

false

署名プロセスにおけるCCの順序位置。署名者のsignOrderと順序を共有します。指定しない場合、既存のCC通知ロジックが適用されます。

customizeSettings

object

false

カスタム設定

notificationSettings

object

false

通知用カスタム設定

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 韓国語

signFiles

array

true

署名ファイル情報のコレクション。表示順序はファイルの追加順です。

fileKey 

string

true

署名ファイルのfileKey。PDF形式のみサポートされます。

fieldType

string

false

コントロールタイプ。eMeteraiを渡すとインドネシアの印紙税コントロールを示します。

pageNo

string

false

コントロールが存在するページ番号。インドネシアの印紙税コントロールでは単一ページの指定のみサポートされ、個別のページ番号を渡す必要があり、1-3や1,3などの連続または非連続の複数ページ形式はサポートされません。

attachments

array

false

封筒添付ファイルのコレクション。表示順序はファイルが追加された順序です。

fileKey 

string

false

ファイルfileKey

signerInfos

array

true

署名者情報コレクション

businessId

string

false

開発者が定義するビジネス番号。長さ制限は500文字まで。

roleTypes

array

false

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

fill-入力

sign-署名

string

false

通知方法。デフォルトはautoです。

auto-userEmailを指定するとメール通知を送信し、phoneNumberを指定するとSMS通知を送信します

none-メッセージ通知を送信しません

email-メール通知を送信します

sms-SMS通知を送信します

WhatsApp-WhatsApp通知を送信します

userEmail

string

false

署名者のメールアドレス

userName

string

true

署名者の氏名。署名ページおよび封筒の外部表示に使用される署名者の氏名を設定します。

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

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 韓国語

signOrder

int

true

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

signTaskSuspend

boolean

false

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

suspensionKey

string

false

ブロックノードの識別子。最大500文字まで。同一エンvelope内で一意である必要があります。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 です。

noAuth- 検証なし

accessCode- 署名パスワードによる検証

sms- SMS OTP 検証

idVerification- 身分証明書による検証

emailAuth- メールアドレス OTP 検証

digitalId- 電子身元証明による検証

whatsappAuth- WhatsApp OTP 検証

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-i AM Smartによる身元確認

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内のパラメータは有効になりません。

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

documentVisibility

object

false

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

documentViewType

string

false

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

viewableFileKeys

array

false

署名者に追加で表示を許可する fileKey のリスト；documentViewType=limited の場合に限り送信可能かつ有効になります。

sealInfos

array

false

署名タスク情報

fileKey

string

true

署名対象ファイルの fileKey

signConfigs

array

false

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

fieldType

string

false

コントロールの種類。デフォルトはsignatureです。

signature-署名コントロール

stamp-図章コントロール

approval-承認コントロール

required

boolean

必須入力かどうか。デフォルトは必須です。

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：AIによる手書き署名

複数選択可能。カンマ（","）で区切ります。デフォルトは全選択です。

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

float

false

x軸座標

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

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

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

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

posY

float

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

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

tickBoxにのみ適用、デフォルトは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

MMM dd,yyyy

dd MMM yyyy

パラメータ名

型

説明

envelopeId

string

エンベロープID

CCInfos

array

CC情報コレクション

userEmail

string

CCメールアドレス

userName

string

CC氏名

signFiles

array

署名ファイル情報コレクション

fileKey

string

署名ファイルのfileKey

attachments

array

エンベロープ添付ファイルコレクション

fileKey

string

ファイルのfileKey

signerInfos

array

署名情報

recipientId

string

署名者ID

businessId

string

開発者がカスタムする業務番号、長さ制限500

userEmail

string

署名者のメールアドレス

userName

string

署名者の氏名

signOrder

int

署名者の署名順序、最小値は1

accessCode

string

署名ページアクセスパスワード