署名者の編集

POST/esignglobal/v1/envelope/recipients/editSigners

API説明

エンベロープ内の署名が完了していない署名者の情報を更新します。

エンベロープ作成後、署名者の連絡先、氏名、通知設定、または認証方法の入力ミスや署名者情報の変更が必要な場合、本APIを使用して署名が完了していない署名者の情報を更新できます。これにより、情報誤りによるエンベロープの無効化と再送信を回避できます。

注意事項

署名が完了していない署名者のみ更新可能です。
署名済み、拒否済みなどの最終状態にある署名者は更新できません。
エンベロープが最終状態または無効状態にある場合は、署名者情報を更新できません。
通知方法にSMSとメールの両方が含まれる場合、単独で「 phoneNumber。
APIは送信された署名者情報と現在の署名者情報を照合し、情報が一致しない場合、該当する署名者情報を更新します。

リクエストパラメータ

パラメータ名				データ型	必須	説明
envelopeId				string	true	エンベロープID
signerInfos				object	true	署名者情報
	recipientId			string	true	参加者ID
	businessId			string	false	開発者指定の業務番号、長さ制限500
	deliveryMethods			string	false	通知方法、デフォルトはauto auto-userEmailを指定するとメール通知を送信し、phoneNumberを指定するとSMS通知を送信します none-メッセージ通知を送信しない email-メール通知を送信 sms-SMS通知を送信 WhatsApp-WhatsApp通知を送信
	userEmail			string	false	署名者のメールアドレス
	userName			string	true	署名者の氏名。署名ページおよび封筒で外部に署名者の氏名を表示するために使用されます。【注】以下の9つの特殊文字を含めることはできません：/ \ : * " < > \| ？およびすべての絵文字
	minimumReadingDuration			int	false	ページの強制読取カウントダウン時間を設定します。デフォルト値は0（単位：秒、最大値999）です。 0または未指定の場合は無効となり、読取カウントダウンは不要です。
	readToEndRequired			boolean	false	最後まで読む必要があるかどうかを示します。デフォルトは false です。 true は有効化、false または未指定の場合は無効化を示します。
	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 韓国語
	authModes			string	false	検証方式、デフォルトはnoAuth noAuth-認証なし accessCode-署名パスワードによる認証 sms-SMS OTP 認証 idVerification-身分証明書による認証 emailAuth-メールOTP認証 digitalId-電子ID認証 whatsappAuth-WhatsApp OTP認証
	authConfig			object	false	認証方法設定
		accessCode		object	false	署名パスコード設定、authModes=accessCodeの場合は必須
			accessCode	string	false	パスコードの内容。大文字と小文字は区別しません。英数字を含めることができ、長さは最大45文字です。
			promptInfo	string	false	アクセスパスコードのヒントメッセージ。アクセスパスコードを含めることはできません。長さは最大30文字。authModes=1の場合は必須。
		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	電子本人確認に使用するアプリ singpass - Singpassを使用して本人認証を行う
			idNumber	string	false	署名者の検証対象となる身分証明書番号
		whatsappAuth		object	false	WhatsApp OTP認証、authModes=whatsappAuthの場合必須
			countryCode	string	false	国・地域の国際コード、「+」は入力不要
			number	string	false	フォーマット検証は行わず、最大長を13桁に制限するのみ

レスポンス例

{
  "code": 0,
  "message": "success",
  "data": {
    "envelopeId": "9fbe6c8190824227bde29136b0145c81",
    "signerInfos": [
      {
        "recipientId": "recipient_123456789",
        "businessId": "biz-20260604-001",
        "userEmail": "new_signer@example.com",
        "userName": "Alex Chen"
      }
    ]
  }
}