メインコンテンツへ
BlueAI
ホーム/Sign(電子署名)/概要

Sign リファレンス

電子署名・契約書管理を扱う Sign ドメインの API

|
契約書(Documents)

契約書の作成・更新・送信・キャンセル・リマインドを行います。

  • GET/api/v1/sign/documents— 契約書一覧を取得
  • POST/api/v1/sign/documents— 契約書を作成
  • GET/api/v1/sign/documents/{id}— 契約書を取得
  • PATCH/api/v1/sign/documents/{id}— 契約書を更新
  • DELETE/api/v1/sign/documents/{id}— 契約書を削除
  • POST/api/v1/sign/documents/{id}/send— 署名依頼を送信
  • POST/api/v1/sign/documents/{id}/cancel— 署名依頼をキャンセル
  • POST/api/v1/sign/documents/{id}/remind— 署名リマインドを送信
ファイル(Files)

契約書に添付するファイルのアップロード・ダウンロード・削除を行います。

  • POST/api/v1/sign/documents/{id}/files— ファイルを追加
  • GET/api/v1/sign/documents/{id}/files/{fileId}— ファイルをダウンロード
  • DELETE/api/v1/sign/documents/{id}/files/{fileId}— ファイルを削除
監査ログ(Audit Logs)

契約書に対する操作履歴(送信・閲覧・署名等)を取得します。

  • GET/api/v1/sign/documents/{id}/audit-logs— 監査ログ一覧を取得
  • GET/api/v1/sign/audit-logs— 監査ログを取得
ゲスト署名(Guest Signing)

トークンベースのゲスト署名。署名依頼メールのリンクから認証なしで署名を実行します。

  • GET/api/v1/sign/s/{token}— 署名情報を取得
  • POST/api/v1/sign/s/{token}— 署名を実行
  • GET/api/v1/sign/s/{token}/files/{fileId}— ゲスト用ファイルダウンロード
ダッシュボード(Dashboard)

Sign のダッシュボード情報を取得します。

  • GET/api/v1/sign/dashboard— ダッシュボードを取得