ヘルプセンター統合

のために: 管理者

ハブキーを使用して電子署名を送信し、署名を読み取る

テンプレートから案件の電子署名を作成し、各項目に署名する人を選択し、署名のために公開し、全員が署名したらロックされたコピーをダウンロードします。

この記事では9 セクション

始める前に

このページでは、電子署名電子署名 電子署名のために送信された文書が、ブラウザ上で署名された。を送信した後、その署名にハブキーを付加する方法について説明しています。これらのパスはhttps://prd-api-app.caseactive.com/v1/<hub id>/<case id>の下に記載されています。

電話

電話その機能
GET /signs/templatesご自身の電子署名テンプレートの一覧です。
POST /signsこのケースに関する電子署名を作成しますが、これはまだ公開されていません。
PUT /signs/<sign_id>/schema各フィールドに誰が署名するかを選びます。
PUT /signs/<sign_id>公開する前に、その名前や発行日、またはリマインダーを変更する。
PUT /signs/<sign_id>/publishそれを公表し、署名者たちに送ります。
GET /signs?filter=allこの事件に関する電子署名の一覧です。
GET /signs/<sign_id>1つの電子署名を読み取り、そのステータスを確認する。
DELETE /signs/<sign_id>それを削除し、関連する署名も一緒に削除します。
GET /signs/<sign_id>/responsesそのシグネチャーの一覧
GET /signs/<sign_id>/responses/<response_id>1つの署名を読み取ります。

電子署名は、いくつかのステップを踏んで行われます。まず、署名者を決めてから、各フィールドに誰が署名しているかを確認し、最後にその署名内容を公開します。公開されるまで、署名者はその署名内容を知りませんし、他の人にも何も伝えられません。一度公開されると、その内容は変更できなくなります。

電子署名を作成する

GET /signs/templates ご自身が公開している電子署名の一覧です。 テンプレートテンプレート 図書館に保管され、ケースにコピーされる、再利用可能なフィード投稿、フォーム、電子署名、メモ、またはタスク。, 最も古いものから順番に、それぞれのものを… asset_id, title, description, due_mins (送信してから、どれくらいの時間が経ったか) notifications, そして、 role_field_participants, 各フィールドに記号が付けられている、その役割です。

POST /signsは、以下のような値を取ります:

分野その機能必須デフォルト
name電子署名のタイトルです。文字、数字、スペース、そして& ' - _ ( ) . /があります。コンマやコロンは含まれていません。はい。—
duration{"due_date": "2026-10-09T17:00:00-04:00"}、そしてそのタイムゾーンオフセットも含まれます。Eサインは繰り返し表示されません。つまり、繰り返し表示するルールは認められません。はい。—
template{"owner": "host", "template_id": "<asset_id>"} は、テンプレートの文書や署名者を使用するためのものです。いいえ。なし
descriptioneサインで表示されているメモいいえ。テンプレートの内容です。
notifications注意事項:{"names": ["days"], "values": [-1440]}。締切日までの時間を分単位で示します。いいえ。テンプレートがある場合、または何もない場合。
instant_notifyfalse は、公開時にどのようなリクエストも送信しない。ただし、リマインダーだけは送信される。いいえ。テンプレートのことです、つまりtrue
curl -X POST https://prd-api-app.caseactive.com/v1/ca-7e6d5c4b3a2f10/cc-1a2b3c4d5e6f70/signs \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"name": "Retainer Agreement", "duration": {"due_date": "2026-10-09T17:00:00-04:00"}, "template": {"owner": "host", "template_id": "sign::20260915101500_7a6b5c4d3e2f10"}}'

201はsign_idで置き換えられます。テンプレートのドキュメントはバックグラウンドでコピーされます。e-signが終了するまで、copyingがなくなるまで読み続けてください。

代わりに、自分でPDFを送信したい場合は、templateを含まない状態で電子署名を行います。その後、PDFファイルをアップロードし、準備が整うのを待ちます。その後、そのファイルのフィールドを割り当てます。詳細は、「Hubキーを使ってファイルをアップロードし、添付する」を参照してください。

誰が署名するかを選ぶ

テンプレートから、各フィールドは、電子署名が作成される際にそのフィールドの役割を担う人々に送信されます。ですから、まずはクライアントをそのケースに追加してください。電子署名のfield_participantsには、各フィールドの名前と、その電子署名を行うユーザーのIDが表示されます。

それを変更するには、マップ全体を PUT /signs/<sign_id>/schema に送信してください。

{"field_participants": {"Client Signature": ["cu-4f1c2a9e8b7d60"], "Attorney Signature": ["cu-9d8c7b6a5f4e30"]}}
  • すべてのIDは、その案件に関わる人でなければなりません。バーチャルアシスタントは、署名を行うことはできません。
  • フィールド名とは、文書内に記載されている名前のことです。
  • この地図は、古い地図を置き換えるものです。省略されている場所には、何の記号もありません。

出版

PUT /signs/<sign_id>/publishは、どのような値も受け取らず、代わりに200を返します。少なくとも1つのフィールドには、シグナーが必要です。シグナーがないフィールドは、空のままです。

  • 各署名者には、すぐに署名を求めるメールが送られます。もしメールアドレスが確認できない場合は、テキストメッセージで通知されます。ただし、… instant_notify はい false. それは、彼らの上に現れているようです。 やるべきことやること 記入すべき書類、署名すべき文書、確認すべきイベントなど、あなたがやらなければならないことのリスト。 そして、彼らのポータル通知にも表示されます。
  • リマインダーは、notificationsの時期に毎回送信されます。それらのリマインダーが受け取られるまで、その処理は続きます。
  • その事件から離れていた人が、その事件を手に取って止めました。

署名に続いて

電子署名のことです。 status 読む completed 全員が署名した後、そして… completed_on UTCで、いつかということです。 2026-10-06T21:42:10.123456+00:00. それまでは、どちらもありませんでした。 responses 各署名者に対して、署名をした人々の情報を記録しています。 response_id.

GET /signs/<sign_id>/responses 各署名者の署名が一覧で表示されており、最も古いものから順番に並んでいます。すべての情報は一ページにまとめられています。 user_id, 彼らが署名したとき、彼らが記入した項目の内容は… response.formFieldValues, 彼らの署名を下さい。 response.annotations, 任意の署名画像を使用しています。 response.attachments, そして、彼らが署名したIPアドレスも含まれています。 response.ip.

この件に関わるスタッフには、毎回、署名が行われたことを伝えられます。また、署名された書類が準備できた時も、同じように伝えられます。つまり、自分で送った場合と同じようにです。そして、署名が完了した時も、そのことを各人に伝えられます。

ロックされたコピー

全員が署名をした後、各人の署名が記載された、ロックされたコピーが作成されます。文書の記録は、以下のようになります。 media.schemas.items 利益 flat, コピーのパスです。 flat_status, SUCCEEDED または FAILED. どのようなファイル形式でもダウンロードできます。詳細はこちらをご覧ください。 Hubキーを持つファイルをアップロードして添付してください。.

リスト表示と削除

GET /signsには、filterが必要です。allでは、ケース内にあるすべての電子署名が一覧表示されます。未公開のものも含まれています。最新のものから順番に表示されます。selfでは、バーチャルアシスタントによって送信された電子署名が一覧表示されます。これらは、キーの操作によって送信されたものです。また、completedやuncompletedでは、発信者自身が送信した電子署名が一覧表示されます。したがって、キーを使用していない場合は、これらの欄は常に空になります。その代わりに、各電子署名のstatusやcompleted_onを確認してください。

DELETE /signs/<sign_id>は、いつでもその電子署名を削除することができます。そして、その電子署名が含まれる情報もすべて削除され、誰のタスクリストからも消え去ります。誰にもそのことを伝えられません。

電話が拒否された場合

状態messageなぜ
400SchemaFieldsExceptionフィールドが欠落しているか、無効な状態です。例えば、name内にカンマがある場合や、繰り返しルールが存在する場合、または、そのケースに含まれていない署名者がいる場合などです。errorsは、そのフィールドの名前を表しています。
400SchemaFieldsException、ItemCopyNotAllowedExceptionはtemplateの値を持ちます。そのテンプレートは、公開されていないか、ボットのロールにアクセスできない状態です。また、そのファイルもまだ処理中の状態です。
403PublishAlreadyPublishedExceptionもう発表されているので、変更することはできません。
403PublishAlreadyAnsweredExceptionすでに、誰かがその文書に署名をしています。
403PublishParticipantsMissingExceptionどのフィールドにも、署名者はいません。
403PublishMediaMissingExceptionまだ、その文書は存在していません。
403PublishMediaNotReadyExceptionその文書は、今もなおコピーされているか、変換されている最中です。
403PublishMediaFailedExceptionその文書は、変換されませんでした。
403PublishDocumentUnreadableExceptionその文書は読めない状態です。電子署名を削除し、再び作成してください。
403PublishDueTimePassedException期限が過ぎてしまいました。
403BotNotAllowedExceptionキーパーは、その署名を消したり、誰かの署名を取り除こうとした。
403CaseClosedExceptionこの事件は、もう終了しました。
404ItemNotFoundException電子署名やサインは存在しません。

エラー内容やその他のコードについては、APIのエラーやステータスコードの処理方法を参照してください。

関連記事

APIで何ができるかを理解しましょう管理キーとハブキーがそれぞれどのような範囲にアクセスできるのか、なぜすべてのキーが仮想アシスタントとして機能するのか、そして完全な技術仕様書はどこにあるのかを学びましょう。統合ハブキーを使用してフォームを送信し、回答を読みます。テンプレートから案件に関するフォームを作成し、記入すべき担当者に公開して、回答を読みます。統合ハブキーを使用してファイルをアップロードおよび添付します。アップロード先アドレスを取得し、ファイルをアップロードして、投稿、メモ、タスク、フォーム、または電子署名に添付し、ケースのファイルをダウンロードします。統合APIエラーとステータスコードを処理するエラー本文を読み、400、401、403、404、500、503の意味、そしてキーで確認できない項目が404エラーを返す理由を確認してください。統合