法的文書を公開

POST /v1/legal-documents · 権限 legal-documents:write

法的文書のバージョンを公開します。KeenAuth は送信プロキシ経由で url を 1 回取得し、本文の SHA-256 ハッシュを content_sha256 として保存します。HTTPS のみ、プライベートアドレスとプラットフォームアドレスはブロック、最大 5 MiB、10 秒です。200 以外の応答や空の本文は取得不能とみなされ、何も保存されません。公開後に url、version、locale、ハッシュは変わりません。effective_at の既定値は現在時刻で、過去にはできません。

リクエスト

JSON ボディ (未知のフィールドは 400 unknown_field で拒否されます):

フィールド タイプ 必須 説明
Idempotency-Key header いいえ リクエストの再試行を安全にする、オプションのキー (16～64 文字)。
kind string はい terms、privacy_notice、custom のいずれか。
version string はい バージョンラベル、1～64 文字。
locale string はい BCP 47 言語タグ。環境で有効になっている必要があります。
url string はい 自社でホストする HTTPS ページ、最大 2048 バイト。
application_id string | null いいえ 文書を適用するアプリケーション (app_…)。省略または null の場合は環境のすべてのアプリケーション。
effective_at string (date-time) いいえ 文書の発効日時。既定値は現在で、過去にはできません。
requires_reacceptance boolean いいえ true の場合、ユーザーは effective_at 以降の次回の対話型サインインで再同意画面を見ます。既定値 false。

レスポンス

201 Created と文書。

{
  "id": "ldoc_01j9xk3m7q8r2s4t6v8w0y2z4a",
  "application_id": null,
  "kind": "terms",
  "version": "2026-10",
  "locale": "en",
  "url": "https://example.com/legal/terms-2026-10",
  "content_sha256": "9f86d081884c7d659a2feaa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a08",
  "effective_at": "2026-11-01T00:00:00Z",
  "requires_reacceptance": true,
  "created_at": "2026-10-05T09:30:00.123456Z",
  "updated_at": "2026-10-05T09:30:00.123456Z"
}

エラー

HTTP コード 概要
400 unknown_field ボディが未知のフィールドを含んでいます。
409 conflict 同じアプリケーション、種類、バージョン、ロケールの文書がすでにあります。
415 unsupported_media_type コンテンツタイプが application/json ではありません。
422 legal_document_unreachable 送信プロキシ経由で URL を取得またはハッシュ化できませんでした。何も保存されていません。
422 validation_failed フィールドが無効です (例: url が HTTPS でない、不明な locale、過去の effective_at、環境にない application_id: unknown_application)。
401 unauthenticated 認証情報が見つからない、無効、または取り消されています。
403 insufficient_permissions 認証情報に必要な権限がありません。
429 rate_limited レート制限を超えました。Retry-After 期間後に再試行してください。
503 service_unavailable このデプロイでは文書の取得が構成されていないか、依存関係が一時的に利用できません。

例

curl -X POST https://api.eu.keenauth.com/v1/legal-documents \
  -H "Authorization: Bearer $KEENAUTH_SECRET_KEY" \
  -H "Content-Type: application/json" \
  -H "Idempotency-Key: $(uuidgen)" \
  -d '{"kind":"terms","version":"2026-10","locale":"en","url":"https://example.com/legal/terms-2026-10","effective_at":"2026-11-01T00:00:00Z","requires_reacceptance":true}'