エラーコード
このページはエラー処理の唯一の情報源です。SDK 固有のエラーコードは各 SDK のエラー処理ページに記載されています。このページでは API コントラクトレベルのエラーを扱います。
HTTP ステータスコード
| コード | 意味 |
|---|---|
200 OK | リクエストが成功しました。 |
400 Bad Request | ペイロードが不正な形式であるか、必須フィールドが欠落しています。本文に問題のあるフィールドが記載されます。 |
401 Unauthorized | 認証が欠落、期限切れ、または無効です。 |
403 Forbidden | 認証は有効ですが、テナントはリクエストされたリソースに対して有効になっていません（例：APIKEY にない機能を呼び出す）。 |
404 Not Found | リソースが存在しないか、認証済みテナントに属していません。 |
409 Conflict | リソースは存在しますが、この操作に適した状態にありません（例：まだ進行中のプロセスからドキュメントを取得する）。 |
410 Gone | リソースは存在しましたが、保持ポリシーに従って削除されました（ドキュメント取得エンドポイント）、またはプロセスは存在しますがエラー状態で終了しました — プロセスの取得を参照。 |
429 Too Many Requests | レート制限に達しました。指数バックオフで再試行してください。 |
5xx | プラットフォームエラー。バックオフで再試行してください。継続する場合は、レスポンスボディとタイムスタンプを添えてサポートに連絡してください。 |
再試行ポリシー
| ステータス | 再試行すべきか | 方法 |
|---|---|---|
5xx | はい | 指数バックオフ（1 秒、2 秒、4 秒、8 秒…）。最大 5 回まで。 |
429 | はい | Retry-After ヘッダーがあれば従う。なければ指数バックオフ。 |
4xx（その他） | いいえ | リクエストが間違っています。再試行前に入力を修正してください。 |
401 | 条件付き | アクセストークンを一度更新してください。新しいリクエストも 401 を返す場合は構造的な問題です — 再試行しないでください。 |
冪等性
IDCloud プラットフォームは現在、作成エンドポイントに冪等性キーのメカニズムを公開していません。プロセスの作成を再試行する際は注意が必要です — 5xx でのネットワークエラーが実際にはサーバーサイドで成功している可能性があり、再試行すると重複プロセスが作成される場合があります。不明な場合は、再試行前に内部の相関 ID で最近のプロセスを取得してください。
SDK エラーの所在
Android SDK、iOS SDK、および Flutter SDK のエラーカタログは、各 SDK 専用のエラー処理ページに記載されています：
これらはデバイス側のエラー（カメラ許可拒否、キャプチャタイムアウト、デバイスのネットワーク到達不能）を扱っており、ここに 記載されている API 側のエラーとは別です。