エンベロープテンプレートを使用して署名を開始する

POST /esignglobal/v1/envelopeTemplates/sendEnvelope

インターフェースの説明

ページ側で事前に設定された「エンベロープテンプレート」を使用して署名を開始します。

リクエストパラメータ

パラメータ名				タイプ	必須	説明
envelopeTemplateId				string	true	エンベロープテンプレートID
envelopeConfig				object	true	署名フロー設定
	contractConfig			boolean	false	契約書署名設定
		envelopeRemark		array	false	契約書の備考
	envelopeSubject			string	true	今回の署名フローの件名
	expireAfterSeconds			int	false	今回の署名フローの署名締切日時。超過すると署名できなくなります。Unixタイムスタンプ（ミリ秒単位）。デフォルトおよび最大有効期限は90日です。
	callbackUrl			string	false	コールバック通知を受信するWebアドレス
	redirectUrl			string	false	有効なhttpsアドレスである必要があります
	signConfig			object	false	署名設定項目
		allowTransfer		boolean	false	署名者がこの封筒を他の人に署名のために転送することを許可するかどうか。デフォルトはfalse true-封筒内の署名者に封筒を他人に転送する権限を付与します； false-封筒内の署名者に封筒を他人に転送する権限を付与しません；
participants				array	false	参加者設定
	participantId			string	true	参加者ID
	authConfig			object	false	認証設定項目
		willingnessAuthModes		array	false	署名者が選択可能な認証方法、デフォルトはnoAuth noAuth-認証なし accessCode-署名コードによる認証 sms-SMS OTP認証 idVerification-身分証明書による認証 emailAuth-メールOTP認証 digitalId-電子認証 whatsappAuth-WhatsApp OTP認証
		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	デジタルID認証に使用するアプリ singpass-Singpassによる本人認証 iamsmart-iAM Smart（智方便）による本人認証
			idNumber	string	false	署名者の検証対象身分証明書番号
		whatsappAuth		object	false	whatsapp OTP検証、authModes=whatsappAuthの場合は必須
			countryCode	string	false	国・地域の国際コード、「+」は不要
			number	string	false	フォーマット検証は行わず、長さは最大13桁に制限
	participantInfos			object	false	個人参加者
		userEmail		string	false	署名者のメールアドレス
		phoneNumber		object	false	電話番号、デフォルトは空 SMS通知が必要な場合は必須パラメータ。countryCodeとnumberの両方を指定する必要があります
			countryCode	string	false	国・地域の国際コード、「+」は不要
			number	string	false	フォーマット検証は行わず、長さは最大13桁に制限
		userName		string	false	個人名
		deliveryMethod		string	false	通知方法 none-メッセージ通知を送信しない email-メール通知を送信する sms-SMS通知を送信する WhatsApp-WhatsApp通知を送信する
		customizeSettings		object	false	カスタム設定
			customizeMessage	object	false	通知用カスタム設定
			notificationLanguage	string	false	通知言語、デフォルトは英語 en-US 英語 zh-CN 簡体中国語 zh-Hant 繁体中国語 ja 日本語 ES-MX スペイン語
copiers				array	false	抄送先を追加
	copierId			string	true	参加者ID
	CCInfos			object	false	抄送先情報
		userEmail		string	false	メールアドレス
		userName		string	false	氏名
		customizeSettings		object	false	カスタム設定
			customizeMessage	object	false	通知用カスタム設定
			notificationLanguage	string	false	通知言語、デフォルトは英語 en-US 英語 zh-CN 簡体中国語 zh-Hant 繁体中国語 ja 日本語 ES-MX スペイン語
attchments				array	false	添付ファイル（署名不要のファイル）情報
	documentId			string	false	添付ファイルID
	fileName			string	false	添付ファイル名
components				array	false	コントロールリスト
	documentId			string	false	コントロール所属ファイルID
	componentId			string	false	コントロールID
	componentKey			string	false	コントロールキー（コントロールIDまたはコントロールキーのいずれかを選択）
	componentValue			string	false	コントロールの事前入力値
	editComponentValue			boolean	false	署名者がこのコントロールの事前入力値を変更可能かどうかを制御。デフォルトはtrue true-署名者は事前入力値を編集可能 false-事前入力値がある場合は読み取り専用でロックされ、署名者は編集不可

リクエスト例

{
  "envelopeTemplateId": "dc4be9641a3145b****9018d7a9180",
  "envelopeConfig": {
    "envelopeSubject": "*****"
  },
  "participants": [
    {
      "participantId": "42750b92c7a34******34dd5342",
      "participantInfos": {
        "userEmail": "***",
        "userName": "Preset Signer"
      }
    }
  ],
  "copiers": [],
  "attachments": [],
  "components": [
    {
      "componentValue": "AutoTextValue",
      "documentId": "d559142***2c3b02c3b5c663aa146",
      "componentId": "30c616512991***d68ab930210c",
    },
    {
      "componentValue": "AutoTextValue",
      "documentId": "d559142672c74***2c3b5c663aa146",
      "componentId": "a130c54c1472444f***6c6e83a2f540"
    },
    {
      "componentValue": "123.4444",
      "documentId": "d559142672c***b02c3b5c663aa146",
      "componentId": "42b76dfbf15e4cf1***a409159c35"
    },
    {
      "componentValue": "0",
      "documentId": "d559142672c7***3b02c3b5c663aa146",
      "componentId": "556b60f7bd32442***3bbec8c54"
    },
    {
      "componentValue": "AutoTextValue",
      "documentId": "d559142672c742c***b5c663aa146",
      "componentId": "7929410bb8754***497d6df30cb2"
    },
    {
      "componentValue": "AutoTextValue",
      "documentId": "d559142672c742c3***c663aa146",
      "componentId": "9e92a77b50b24cd***f6ade4b7d9"
    },
    {
      "componentValue": "123",
      "documentId": "d559142672c7402c3***b5c663aa146",
      "componentId": "9600135a35fb4ff***4ce42b6af"
    },
    {
      "componentValue": "0,1",
      "documentId": "d559142672c742c***b5c663aa146",
      "componentId": "d41cea8f288e***4c18c0289a"
    },
    {
      "componentValue": "1",
      "documentId": "d559142672c***b02c3b5c663aa146",
      "componentId": "9edab2c19***08b3c2dcc2d1a78171"
    },
    {
      "componentValue": "0",
      "documentId": "d559142672c74***c3b5c663aa146",
      "componentId": "4a6136cd81c54***01c113fcd30"
    },
    {
      "componentValue": "***",
      "documentId": "d559142672c7***02c3b5c663aa146",
      "componentId": "73d836894fb34***fb90fcd813"
    },
    {
      "componentValue": "***",
      "documentId": "d5591426***b02c3b5c663aa146",
      "componentId": "4e22fe4be9314a8***81d5354b51da4"
    }
  ]
}

レスポンスパラメータ

パラメータ名	型	説明
envelopeId	string	エンベロープID

レスポンス例

{
  "code": "0",
  "data": {
    "envelopeId": "4e2eb9cc95044a7****a9a81f76397"
  },
  "message": "SUCCESS"
}