封筒の作成

POST /esignglobal/v1/envelope/create

インターフェースの説明

下書き状態の封筒を作成します。

リクエストパラメータ

パラメータ名		型	必須かどうか	説明
subject		string	true	封筒の件名、例：「Offer Letter」
remark		string	false	封筒のメモ、文字数制限1000字
signerSettings		object	false	署名者が実行できる操作
	allowTransfer	boolean	false	署名者がこの封筒を他の人に転送できるかどうか、デフォルトはfalse true-封筒内の署名者に他人への転送権限を与える； false-封筒内の署名者に他人への転送権限を与えない；
	allowModifyName	boolean	false	署名者が氏名を変更できるかどうか、テンプレート署名にのみ有効、デフォルトはfalse true-署名者の氏名変更を許可 false-署名者の氏名変更は許可されません
tspScope		array	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。
expireAfterSeconds		long	false	封筒の有効期限：何秒後に封筒が期限切れになるか有効期限の範囲：86,400秒（1日）〜7,776,000秒（90日）。
redirectUrl		string	false	署名完了後のリダイレクトアドレス（最大2048文字）、有効なhttpアドレスである必要があります
callBackUrl		string	false	コールバックアドレス（最大500文字）、https/httpプロトコルのアドレスである必要があります

リクエスト例

  {
    "subject": "api subject fdsfasdfafs",
    "remark": "This is a remark",
    "tspScope": ["corpId", "vinotek", "eSignPersonal"],
    "expireAfterSeconds": 888640,
    "redirectUrl": "https://www.example.com"
}

レスポンスパラメータ

パラメータ名

型

説明

envelopeId

string

封筒ID

envelopeStatus

int

封筒ステータス

0-作成済み（ドラフト）

1-署名中

2-完了

3-期限切れ

5-取り消し済み

レスポンス例

{
    "code": "0",
    "data": {
        "envelopeId": "9fbe6c8190824227bde29136b0145c81",
        "envelopeStatus": 0
    },
    "message": "success"
}