署名依頼 API
署名依頼 API を使うと、自社のシステムから文書の署名を依頼できます。API でいう envelope(エンベロープ)は、アプリでいう署名依頼のことで、名前が違うだけで同じものです。署名依頼には、最大 10 件の文書、それに署名する人や受け取る人、各署名者が入力する欄が含まれます。
AutomaDoc Sign が記録するのは、監査証跡付きの簡易な電子署名です。誰が、いつ、どこから署名したか、そしてすべてのファイルのフィンガープリント(SHA-256)が記録されます。証明書に基づくデジタル署名ではありません。文書の中には(遺言、家族関係の手続き、裁判所への提出書類など)、また公的なシステムの中には、別の形式の署名を必要とするものがあるので、あなたの文書に何が必要かを確認してください。
どのルートにも会社の API キー(amk_ で始まるもの)が必要です。次のどちらかのヘッダーで送ります。
X-Webhook-API-Key: amk_…Authorization: Bearer amk_…会社のキーは、管理者が会社ポータルの 会社 → API キー で作成します(API クイックスタートを参照)。テンプレート自身のキーはそのテンプレート 1 つにしか使えず、会社の署名依頼には使えません。API_KEY_INVALID で拒否されます。キーからは、API で作ったものかポータルで作ったものかにかかわらず会社のすべての署名依頼が見え、ほかの会社のものは一切見えません(ENVELOPE_NOT_FOUND)。
2 つの回数制限があります。
- キーごとに 1 分あたり 60 リクエスト。すべての署名依頼ルートの合計です。
- 会社ごとに 1 分あたり 600 ドキュメント。ドキュメント API と HTTPトリガーと共有です。作成は、含まれる文書 1 件ごとに 1 と数えます。
どちらかを超えると、429 と RATE_LIMITED が返ります。
署名依頼が送信されるまで
Section titled “署名依頼が送信されるまで”POST /api/v1/envelopesは文書を保存して、すぐに201を返します。この時点で署名依頼はまだdraftで、各文書はprepareState: "pending"です。- AutomaDoc が各文書を準備します。Word、Excel、PowerPoint のファイルは PDF になり、テキストからアンカーと
[[…]]タグが検索されます。30 分たっても pending のままの文書はtimeoutで失敗します。 - 最後の文書の準備が終わると、アンカーとタグからの入力欄が配置され、
send: trueなら署名依頼が送信されます。順番が来ているメールの受信者に招待が届きます。 - 進み具合は
GET /api/v1/envelopes/:idで確認します。送信できなかった場合はdraftのままで、sendErrorに理由が入ります。
公開 API には送信専用の呼び出しはありません。send: true を指定せずに作成した署名依頼は下書きのままです。送信できなかった下書きを API から再試行することもできないので、新しい署名依頼を作成してください。30 日間誰も変更しなかった下書きは削除されます。
署名依頼を作成する
Section titled “署名依頼を作成する”POST https://api.automadoc.cc/api/v1/envelopes本文は JSON(Content-Type: application/json、最大 14 MB)で送るか、multipart/form-data で、同じ JSON を入れた envelope パートとファイルごとのパートを送ります(リクエスト全体で最大 26 MB)。
| フィールド | 必須 | 内容 |
|---|---|---|
title |
はい | 署名者とメールに表示されます。最大 200 文字。 |
message |
いいえ | 受信者へのメッセージ。最大 1,000 文字。 |
documents |
はい | 1〜10 件の文書。順番どおりに並べます(下記参照)。 |
recipients |
はい | 1〜20 人の受信者(下記参照)。 |
fields |
いいえ | 座標で配置する入力欄(下記参照)。最大 500 個。 |
anchors |
いいえ | 文書内のテキストを基準に配置する入力欄(下記参照)。最大 50 個。 |
autoTags |
いいえ | true にすると、文書に書かれた [[…]] タグから入力欄を配置します(下記参照)。 |
send |
いいえ | true にすると、文書の準備と入力欄の配置が終わりしだい署名依頼を送信します。指定しなければ下書きのままです。 |
locale |
いいえ | メールと署名ページの言語:en、zh、id、es、vi、th、ja。それ以外は無視されます。 |
timezone |
いいえ | 文書と完了証明書に書かれる日付に使う IANA タイムゾーン(Asia/Jakarta)。既定は UTC。 |
expiryDays |
いいえ | 送信から有効期限までの日数:1〜120、既定は 30。 |
reminders |
いいえ | { "everyDays": 3, "max": 3 }(既定。everyDays は 1〜30、max は 0〜10)、またはリマインドなしの false。 |
appendCertificate |
いいえ | 既定は true:各署名済み PDF の末尾に完了証明書が付きます。完了証明書はいつでも単体でもダウンロードできます。 |
各文書は次のいずれか 1 つです。
| フィールド | 内容 |
|---|---|
base64 |
ファイルのバイト列を base64 にしたもの(data: の接頭辞も使えます)。1 件のリクエストの base64 の文書は、デコード後の合計で最大 10 MB です。それより大きいファイルは multipart で送ってください。 |
file |
ファイルを入れた multipart リクエストのパート名。 |
generationId |
AutomaDoc があなたの会社のために生成した完了済みの文書(ドキュメント API の generationId、またはまだ保存されているほかの生成文書)。ファイルは署名依頼にコピーされます。 |
name は任意です。既定では、パートのファイル名、生成ファイルの名前、または「Document 1」「Document 2」になります。末尾の .pdf、.docx、.xlsx、.pptx は取り除かれます。ファイルは PDF、Word、Excel、PowerPoint のいずれかで、名前ではなく中身で判定されます。1 ファイルは最大 25 MB、1 件の署名依頼のファイルは合計で最大 50 MB です。
| フィールド | 必須 | 内容 |
|---|---|---|
key |
はい | この受信者に付ける独自の名前(client)。fields と anchors で使われ、すべてのレスポンスで返されます。1〜60 文字の文字、数字、_、-、. で、リクエスト内で一意にします。 |
role |
はい | signer(入力欄に入力して署名する)または cc(署名済みの結果を受け取る)。 |
name |
はい | 最大 120 文字。 |
email |
reach: "email" のとき |
招待の送信先。リンクの受信者では任意です。 |
reach |
いいえ | "email"(既定):この受信者の番が来ると AutomaDoc が招待をメールで送ります。"link":メールは送られず、作成時のレスポンスで signingUrl が返されるので、あなたが相手に届けます。 |
routingOrder |
いいえ | 1〜100、既定は 1。同じ番号の受信者は同時に署名し、大きい番号の受信者は、それより小さい番号の全員が終わるまで待ちます。 |
accessCode |
いいえ | 文書を見る前に受信者が入力する 6〜128 文字のコード。5 回間違えるとリンクはロックされます。リンクと同じメッセージではなく、別の手段で受信者に伝えてください。 |
slot |
いいえ | autoTags 使用時:この受信者が担当する、タグで使われている役割名(Client)。 |
座標による入力欄
Section titled “座標による入力欄”| フィールド | 必須 | 内容 |
|---|---|---|
document |
はい | documents 内の文書の番号(0 から)。 |
recipient |
はい | 受信者の key。入力欄を持てるのは署名者だけです。 |
type |
はい | signature、initials、name、date_signed、text、checkbox、company、email のいずれか。 |
page |
はい | ページ番号(1 から)。 |
x, y, w, h |
はい | 位置とサイズ(ポイント、1/72 インチ)。表示されたとおりのページ(回転後)の左上の角から測ります。入力欄の幅と高さは 8 ポイント以上で、ページ内に収まっている必要があります。 |
required |
いいえ | 既定は true。 |
label |
いいえ | 署名者に表示されるヒント。最大 100 文字。 |
options |
いいえ | テキスト欄用:maxLength(1〜1,000)、validate("number" または "email")、fontSize(6〜72。収まるように縮小されます)。 |
name と email には受信者の名前とアドレスが最初から入っており、署名者が変更できます。date_signed には署名日が署名依頼のタイムゾーンで入ります。ページと位置は、署名依頼の送信時に準備済みの文書に対して確認されます(field_bad_page、field_off_page)。Word のファイルは変換されるまでページがないためです。
アンカーテキストによる入力欄
Section titled “アンカーテキストによる入力欄”アンカーは文書にすでにあるテキストを基準に入力欄を置くので、座標は必要ありません。
| フィールド | 必須 | 内容 |
|---|---|---|
anchor |
はい | 検索するテキスト。最大 200 文字。完全一致で、大文字と小文字を区別します。スペースや改行の連続は、ほかのどんな連続とも一致します。 |
recipient |
はい | 受信者の key。 |
type |
はい | 入力欄の種類(上記と同じ)。 |
occurrence |
いいえ | "all"(既定:一致したすべての場所に入力欄を置きます。最大 200 か所)、または n 番目の一致だけを指す n。署名依頼のすべての文書を通して、読む順に数えます。 |
offsetX, offsetY |
いいえ | 一致したテキストの左上から入力欄の左上までの距離(ポイント、-2,000〜2,000、既定は 0)。offsetY が負なら上に動きます。 |
w, h |
いいえ | 入力欄のサイズ(ポイント、8〜1,000)。既定:署名 160×48、イニシャル 64×40、チェックボックス 14×14、日付 110×20、メールアドレス 180×20、そのほかのテキスト 160×20。 |
required, label |
いいえ | 座標による入力欄と同じです。 |
ページからはみ出す入力欄は、ページ内に戻されます。何にも一致しないアンカーからは入力欄が作られず、たいていは sendError の signer_without_fields として現れます。
タグによる入力欄
Section titled “タグによる入力欄”autoTags: true にすると、文書に書かれたタグが、タグの役割と slot が一致する受信者の入力欄になります(完全一致で、大文字小文字も区別します)。
[[sign:Client]] [[initials:Client]] [[name:Client]] [[date:Client]][[text:Client:PO number]] [[check:Client]] [[company:Client]] [[email:Client]][[sign:Client;w=180;h=50]] [[text:Client:Notes;optional]]入力欄の左上の角はタグの左上の角に合わせられるので、入力欄がタグを覆います。どの受信者も担当していない役割のタグからは、入力欄は作られません。
201 Created と署名依頼が返ります。作成直後は、文書の準備がまだ終わっていない下書きです。
{ "id": "env_01JAB3K9Q7M2X8R4T6V0W1Y2Z3", "status": "draft", "finishing": false, "finalizeFailed": false, "title": "Service agreement ACME-2026-114", "createdAt": 1792290600000, "sentAt": null, "expiresAt": null, "completedAt": null, "documents": [ { "id": "doc_01JAB3K9RA5C7E9G1H3J5K7M9N", "name": "Service agreement", "prepareState": "pending", "prepareError": null, "pageCount": null, "originalSha256": "3b7e0c…", "preparedSha256": null, "finalSha256": null, "deliveredSha256": null } ], "recipients": [ { "id": "rcp_01JAB3K9R2B4D6F8H0J2K4M6P8", "key": "client", "role": "signer", "name": "Dana Lee", "email": "dana@example.com", "status": "created", "routingOrder": 1, "viewedAt": null, "completedAt": null, "declineReason": null } ], "auditHead": "a41f9d…", "sendError": null}reach: "link" の受信者には signingUrl(https://sign.automadoc.cc/#/…)も含まれますが、このレスポンスにだけ含まれます。あとで取得しても返されないので、ここで保存してください。リンクは署名依頼が送信された時点で使えるようになります。メールの招待やリマインドには毎回新しいリンクが入るため、リンクの受信者にメールでリマインドが送られることはありません。
署名依頼を取得する
Section titled “署名依頼を取得する”GET https://api.automadoc.cc/api/v1/envelopes/{envelopeId}作成時と同じ形で、現在の状態を返します。文書の準備中は数秒ごとにポーリングしてください。署名依頼が送信されたあとは、数分ごとで十分です。
status |
意味 |
|---|---|
draft |
未送信:文書の準備中、send が指定されていない、または送信できなかった理由が sendError にあります。 |
sent |
署名待ちです。 |
completed |
全員が署名し、署名済みファイルの準備ができています。 |
declined |
署名者が辞退しました。その受信者の declineReason に理由があります。 |
voided |
あなたが取り消しました。 |
expired |
全員が署名する前に expiresAt を過ぎました。 |
finishing: true(status: "sent" とともに)は、全員が署名し、署名済み PDF を作成中であることを示します。finalizeFailed: true は、すべての再試行のあとも作成できなかったことを示します。署名は保持されており、当社のチームに通知されています。
受信者は created(まだ番が来ていない)、sent、viewed と進み、completed か declined になります。cc の受信者は最初から sent です。
各文書には、段階ごとの SHA-256 が含まれます。originalSha256(あなたのファイル)、preparedSha256(全員が見て署名した PDF)、finalSha256(署名を書き込んだもの)、deliveredSha256(ダウンロードするファイル:署名を書き込み、追加する設定なら完了証明書を付けたもの)です。auditHead は、署名依頼の監査証跡の最後のイベントのハッシュです。届けられたファイルは、誰でも POST https://api.automadoc.cc/api/verify に { "sha256": "…" }(ファイル全体の小文字の 16 進数)を送って確認でき、完了した署名依頼と一致するかどうかが返されます。
署名依頼の一覧を取得する
Section titled “署名依頼の一覧を取得する”GET https://api.automadoc.cc/api/v1/envelopes?status=completed&since=1792290600000&limit=50| クエリ | 内容 |
|---|---|
status |
draft、sent、completed、declined、voided、expired のいずれか。 |
since |
この時刻(Unix ミリ秒)以降に更新された署名依頼だけ。 |
limit |
1〜100、既定は 25。 |
cursor |
前のページの nextCursor。 |
レスポンスは新しい順の { "envelopes": [ … ], "nextCursor": "…" } です。最後のページでは nextCursor が null になります。ポータルで作った署名依頼の受信者では、key は null です。
署名済みファイルをダウンロードする
Section titled “署名済みファイルをダウンロードする”GET https://api.automadoc.cc/api/v1/envelopes/{envelopeId}/documents/{documentId}/signedGET https://api.automadoc.cc/api/v1/envelopes/{envelopeId}/certificateGET https://api.automadoc.cc/api/v1/envelopes/{envelopeId}/combinedsigned は署名済み文書 1 件、certificate は完了証明書単体、combined はすべての署名済み文書を 1 つにまとめた PDF です(追加する設定なら末尾に完了証明書が付きます)。combined は文書が 2 件以上ある署名依頼でのみ作られます。どれも署名依頼が completed になってから使えます。それより前は 409 と DOCUMENT_NOT_FOUND が返ります。
レスポンスはファイルそのものではなく、短時間だけ有効なリンクです。
{ "url": "https://api.automadoc.cc/api/esign-files/env_01JAB3K9Q7M2X8R4T6V0W1Y2Z3/final/doc_01JAB3K9RA5C7E9G1H3J5K7M9N.pdf?e=…&d=a&n=…&s=…", "filename": "Service agreement.pdf", "expiresAt": 1792306800000, "sha256": "e5a01c…"}url は 15 分以内に取得してください。キーは不要です。期限が切れたらもう一度リクエストすると新しいリンクが返ります。sha256 はファイルのフィンガープリントです(signed の場合は文書の deliveredSha256)。ダウンロードはすべて監査証跡に記録されます。完了した署名依頼の署名済みファイルは、誰かが削除するまで保管されます。
署名依頼を取り消す
Section titled “署名依頼を取り消す”POST https://api.automadoc.cc/api/v1/envelopes/{envelopeId}/void{ "reason": "Replaced by version 2" }送信済みの署名依頼を止めます。リンクは使えなくなり、すでに依頼を受け取っていた受信者にはメールで通知されます。reason は必須です(最大 500 文字)。voided になった署名依頼が返ります。取り消せるのは、送信済みでまだ受付中の署名依頼だけです。
受信者にリマインドを送る
Section titled “受信者にリマインドを送る”POST https://api.automadoc.cc/api/v1/envelopes/{envelopeId}/recipients/{recipientId}/remindrecipientId は受信者の id(rcp_…)で、あなたが付けた key ではありません。受信者に新しいリンクをすぐにメールで送り、以前のメールのリンクは使えなくなります。番が来ているメールの受信者にだけ、10 分に 1 回まで送れます。{ "remindedAt": 1792300000000, "channel": "email" } が返ります。自動のリマインドは、呼び出しなしで署名依頼の reminders の設定どおりに送られます。
例:curl
Section titled “例:curl”署名者 1 人の署名依頼を作成し、「Client signature:」というテキストの隣に署名欄を、「Date:」の隣に日付を置いて送信します。JSON は envelope パートに、PDF は contract という名前のパートに入れます。
cat > envelope.json <<'EOF'{ "title": "Service agreement ACME-2026-114", "message": "Please review and sign by Friday.", "timezone": "Asia/Jakarta", "documents": [{ "name": "Service agreement", "file": "contract" }], "recipients": [ { "key": "client", "role": "signer", "name": "Dana Lee", "email": "dana@example.com" } ], "anchors": [ { "anchor": "Client signature:", "recipient": "client", "type": "signature", "offsetX": 110, "offsetY": -10 }, { "anchor": "Date:", "recipient": "client", "type": "date_signed", "offsetX": 40, "occurrence": 1 } ], "send": true}EOF
curl -X POST 'https://api.automadoc.cc/api/v1/envelopes' \ -H "X-Webhook-API-Key: $AUTOMADOC_KEY" \ -F 'envelope=<envelope.json' \ -F 'contract=@contract.pdf;type=application/pdf'status が sent になる(または sendError が設定される)まで確認し、その後 completed になるまで確認します。
curl -s 'https://api.automadoc.cc/api/v1/envelopes/ENVELOPE_ID' \ -H "X-Webhook-API-Key: $AUTOMADOC_KEY"完了したら、署名済み文書のリンクを取得してダウンロードします。
url=$(curl -s 'https://api.automadoc.cc/api/v1/envelopes/ENVELOPE_ID/documents/DOCUMENT_ID/signed' \ -H "X-Webhook-API-Key: $AUTOMADOC_KEY" | jq -r .url)curl -s -o signed.pdf "$url"同じ作成を JSON で行う場合は、ファイルを base64 に入れます:"documents": [{ "name": "Service agreement", "base64": "JVBERi0xLjcK…" }]。
例:Node.js
Section titled “例:Node.js”Node.js 18 以降が必要です。AUTOMADOC_KEY=amk_… node sign.mjs で実行します。
import { readFile, writeFile } from 'node:fs/promises'import { createHash } from 'node:crypto'
const API = 'https://api.automadoc.cc'const KEY = process.env.AUTOMADOC_KEY
async function call(method, path, body) { const res = await fetch(API + path, { method, headers: body ? { 'X-Webhook-API-Key': KEY, 'Content-Type': 'application/json' } : { 'X-Webhook-API-Key': KEY }, body: body ? JSON.stringify(body) : undefined, }) const json = await res.json() if (!res.ok) throw new Error(`${res.status} ${json.code}: ${json.error}`) return json}
const pdf = await readFile('contract.pdf')let envelope = await call('POST', '/api/v1/envelopes', { title: 'Service agreement ACME-2026-114', documents: [{ name: 'Service agreement', base64: pdf.toString('base64') }], recipients: [{ key: 'client', role: 'signer', name: 'Dana Lee', email: 'dana@example.com' }], anchors: [{ anchor: 'Client signature:', recipient: 'client', type: 'signature', offsetX: 110, offsetY: -10 }], send: true,})
// The documents are prepared and the fields placed, then the envelope is sent.while (envelope.status === 'draft' && !envelope.sendError) { await new Promise((resolve) => setTimeout(resolve, 2000)) envelope = await call('GET', `/api/v1/envelopes/${envelope.id}`)}if (envelope.sendError) throw new Error(`Not sent: ${JSON.stringify(envelope.sendError)}`)console.log(`${envelope.id} is ${envelope.status}`)
// Later (a scheduled job, say): download every signed document of a completed envelope.export async function downloadSigned(envelopeId) { const current = await call('GET', `/api/v1/envelopes/${envelopeId}`) if (current.status !== 'completed') return false for (const doc of current.documents) { const link = await call('GET', `/api/v1/envelopes/${envelopeId}/documents/${doc.id}/signed`) const bytes = Buffer.from(await (await fetch(link.url)).arrayBuffer()) if (createHash('sha256').update(bytes).digest('hex') !== link.sha256) throw new Error('Download damaged') await writeFile(`${doc.id}.pdf`, bytes) } return true}エラーは JSON で返ります:{ "code": "…", "error": "English text" }。リクエストの問題のある部分がわかる場合は、path がそれを示します(recipients[1].email)。
| HTTP | code |
発生する状況 |
|---|---|---|
| 400 | INVALID_REQUEST |
リクエストが正しくありません。path と error を確認してください。 |
| 401 | API_KEY_MISSING |
X-Webhook-API-Key にも Authorization にもキーがありません。 |
| 403 | API_KEY_INVALID |
キーが不明か無効化されているか、テンプレート自身のキーです。 |
| 403 | ESIGN_SEND_BLOCKED |
リマインド:会社のメールに関する報告を確認している間、送信が一時停止されています。サポートにお問い合わせください。 |
| 404 | ENVELOPE_NOT_FOUND |
その署名依頼はあなたの会社にありません。 |
| 404 | RECIPIENT_NOT_FOUND |
リマインド:その受信者はこの署名依頼にいません。 |
| 404 | DOCUMENT_NOT_FOUND |
ダウンロード:その文書またはファイルがありません(文書が 1 件の署名依頼の combined ファイルなど)。 |
| 404 | GENERATION_NOT_FOUND |
generationId があなたの会社の生成文書ではありません。 |
| 409 | GENERATION_NOT_COMPLETED |
生成文書が完了していないか、もう保存されていません。 |
| 409 | DOCUMENT_NOT_FOUND |
署名依頼の完了前にダウンロードしようとしました。 |
| 409 | ENVELOPE_NOT_DRAFT |
一度も送信されていない署名依頼を取り消そうとしたか、リマインドを送ろうとしました。 |
| 409 | ENVELOPE_CLOSED |
完了、辞退、取り消し、期限切れになった署名依頼を取り消そうとしたか、リマインドを送ろうとしました。 |
| 409 | ENVELOPE_FINISHING |
全員の署名後、署名済みファイルの作成中に取り消しやリマインドをしようとしました。 |
| 409 | NOT_ALLOWED |
番が来ていない受信者、またはリンクの受信者にリマインドを送ろうとしました。 |
| 410 | ENVELOPE_CLOSED |
署名依頼のファイルが削除されたあとにダウンロードしようとしました。 |
| 413 | FILE_TOO_LARGE |
25 MB を超えるファイル、または 26 MB を超える multipart リクエスト。 |
| 413 | ENVELOPE_TOO_LARGE |
base64 の文書の合計が 10 MB を超えているか、ファイルの合計が 50 MB を超えています。 |
| 413 | INVALID_REQUEST |
14 MB を超える JSON 本文。 |
| 415 | UNSUPPORTED_FILE |
PDF、Word、Excel、PowerPoint のいずれでもないファイル。 |
| 429 | RATE_LIMITED |
キーで 1 分あたり 60 リクエスト、または会社で 1 分あたり 600 ドキュメントを超えました。 |
| 429 | ESIGN_SEND_RATE_LIMITED |
リマインド:この受信者には 10 分以内にリマインドを送っています。 |
| 502 | ESIGN_WORKER_UNAVAILABLE |
リマインド:リマインドを届けられませんでした。 |
| 503 | ESIGN_WORKER_UNSUPPORTED |
現在、署名用に文書を準備できません。あとでもう一度お試しください。何も作成されていません。 |
文書の保存中に拒否された作成では、下書きとそのファイルが削除されるので、作りかけのものが残ることはありません。
署名依頼が送信されなかった理由
Section titled “署名依頼が送信されなかった理由”send: true の場合、送信は作成のレスポンスを返したあとに行われます。そのため、送信が拒否された理由は HTTP ステータスではなく、署名依頼(draft のまま)の sendError に入ります。
sendError.code |
意味 |
|---|---|
SEND_PROBLEMS |
署名依頼が完成していません。problems に理由が並びます(下記参照)。 |
QUOTA_EXCEEDED |
月間の枠とすべてのドキュメントパックを使い切りました(料金を参照)。 |
ESIGN_SEND_RATE_LIMITED |
Free:会社が直近 1 時間にすでに 3 件の署名依頼を送信しています。どのプランでも:1 分間に 10 件を超える送信。 |
ESIGN_RECIPIENT_CAP |
この送信で、会社が 1 日に送れる受信者数を超えてしまいます(下記参照)。 |
ESIGN_SEND_BLOCKED |
会社のメールに関する報告を確認している間、送信が一時停止されています。サポートにお問い合わせください。 |
ESIGN_EMAIL_UNAVAILABLE |
この署名依頼ではメールを送れません。何も送信も課金もされていません。reach: "link" の受信者なら引き続き使えます。 |
ESIGN_EMAIL_UNVERIFIED |
キーを作成した人に、確認済みのメールアドレスがありません。 |
ESIGN_ALREADY_PENDING |
この生成文書は、すでに別の署名依頼で署名待ちになっています。 |
INVALID_REQUEST |
タグとアンカーから合わせて 500 個を超える入力欄ができたか、予期しない問題が起きました。 |
各問題は { "code": "…" } で、特定の文書、受信者、入力欄に関するものなら documentId、recipientId、fieldId が付きます(あなたが付けた key ではなく id です)。
| 問題 | 意味 |
|---|---|
document_failed |
文書を準備できませんでした。理由はその文書の prepareError にあります(下記参照)。 |
too_many_pages |
文書の合計が 300 ページを超えています。 |
envelope_too_large |
ファイルの合計が 50 MB を超えているか、準備済み PDF の合計が 100 MB を超えています。 |
no_signer |
役割が signer の受信者がいません。 |
signer_without_fields |
入力欄のない署名者がいます。アンカーが何にも一致しなかったか、タグの役割に slot がありませんでした。 |
recipient_missing_email |
メールの受信者にアドレスがありません。 |
recipient_role_unavailable |
signer と cc 以外の役割です。 |
too_many_fields |
入力欄が 500 個を超えています。 |
field_for_non_signer |
cc の受信者に入力欄が割り当てられています。 |
field_bad_page |
入力欄のページが文書の最後のページより後です。 |
field_off_page |
入力欄がページからはみ出しているか、8 ポイントより小さくなっています。 |
field_type_unavailable |
上記の 8 種類以外の入力欄です。 |
文書の prepareError は次のいずれかです:pdf_encrypted(PDF がパスワードで保護されている)、file_too_large(準備済み PDF が 50 MB を超える)、too_many_pages、unsupported_file、invalid_file(ファイルが破損している)、conversion_failed、source_unavailable、timeout、internal。
| 上限 | 値 |
|---|---|
| 1 件の署名依頼の文書数 | 10 |
| 1 ファイル | 25 MB |
| 1 件の署名依頼のファイル合計 | 50 MB |
| 準備済みの文書 1 件(全員が署名する PDF) | 50 MB |
| 1 件の署名依頼の準備済み文書の合計 | 100 MB |
| 1 件の署名依頼の文書の合計ページ数 | 300 |
| 1 件の署名依頼の受信者数 | 20 |
| 1 件の署名依頼の入力欄数 | 500 |
| 1 件のリクエストのアンカー数 | 50(それぞれ最大 200 か所に一致) |
| JSON のリクエスト本文 | 14 MB(base64 の文書は最大 10 MB) |
| multipart リクエスト | 26 MB |
| 有効期限 | 送信から 1〜120 日、既定は 30 日 |
| リマインド | 1〜30 日ごと、最大 10 回。既定は 3 日ごとに 3 回 |
| リンクがロックされるまでのアクセスコードの誤入力 | 5 回 |
| ダウンロードリンク | 15 分 |
| 下書き | 変更がないまま 30 日たつと削除 |
| 辞退、取り消し、期限切れになった署名依頼のファイル | 終了の 90 日後に削除 |
26 MB を超えるファイルを送るには、generationId で追加してください。この方法ならファイルがリクエストに含まれません。
送信の上限。 Pro も Business シートもない会社は、1 時間に 3 件まで署名依頼を送信でき、1 日に 20 人(アカウント作成から 24 時間は 1 日 5 人)までの受信者に届けられます。Pro または Business シートがあれば、1 日 1,000 人まで届けられます。cc とリンクの受信者を含むすべての受信者が、直近 24 時間で数えられます。どの会社も、1 分間に送信できる署名依頼は 10 件までです。
- 送信した署名依頼 1 件につき、ドキュメント 1 件分を枠から消費します。含まれる文書や受信者の数は関係ありません。送信した時点で課金され、あとで取り消し、辞退、期限切れになっても返還されません。下書きは無料です。
- AutomaDoc で生成した文書は、初めて送るときは無料です。 文書がすべて
generationIdからの署名依頼は無料ですが、そのうち 1 件でもすでに別の署名依頼で送ったものがあれば、ドキュメント 1 件分かかります。生成した文書とアップロードしたファイルが混ざった署名依頼は 1 件分です。 - 支払いの対象。 会社のキーで送信した署名依頼は、ドキュメント API と同じく自動生成ドキュメントです。Pro(またはトライアル)なら無料です。それ以外は、まず Business シートの自動生成の枠から、次に月間の無料枠から、その次にドキュメントパックから差し引かれます。すべて使い切ると、
sendErrorがQUOTA_EXCEEDEDになります。Starter シートは個人に付くもので、API からの送信には使えません。
上記の送信の上限は、すべてのプランに適用されます。