API を呼び出すときにエラーが発生した場合、エラー応答が返されます。その中の `result` フィールド には、エラーコード ( result.resultCode ) とエラーメッセージ ( result.resultMessage ) が含まれます。以下の エラーコード セクションに基づいて、特定の問題のトラブルシューティングを行うことができます。エラーが解決しない場合は、ZOLOZ のテクニカルサポートチームに連絡して支援を求めることもできます。
エラーコード
ZOLOZ は 2 種類のエラーコードを返します。
すべての API に適用される共通エラーコード – API リクエストの呼び出しステータスを示します
特定の API にのみ適用される API 固有のエラーコード – 特定の API の詳細な処理結果を示します
共通リザルトコード
次の表は、共通リザルトコードに関する情報を示しています。ここにリザルトコードが見つからない場合は、代わりに API 固有のリザルトコード セクションをご参照ください。
統合が不完全な場合、エラーリザルトが発生する可能性があります。正しい統合プロセスについては、API 認証情報の準備 をご参照ください。
resultCode | resultStatus | resultMessage |
SUCCESS | S | リクエストは成功しました。 |
PARAM_MISSING | F | 不正なリクエストです。パラメーターがありません。 |
PARAM_ILLEGAL | F | 不正なリクエストです。パラメーターが不正です。 |
MSG_PARSE_ERROR | F | 不正なリクエストです。メッセージフォーマットが無効です。 |
SIGNATURE_INVALID | F | 権限がありません。署名が無効です。 |
KEY_NOT_FOUND | F | キーが見つかりません。 権限がありません。ZOLOZ サーバーがキーを見つけられません。 |
MERCHANT_NOT_FOUND | F | マーチャントが見つかりません。 ZOLOZ サーバーがマーチャントを見つけられません。 |
OAUTH_FAIL | F | 権限がありません。OAuth 2.0 の権限付与に失敗しました。 |
OAUTH_RESOURCE_CODE_FAIL | F | 権限がありません。リソースコードが空白です。 |
ACCESS_DENIED | F | 権限がありません。API へのアクセス権がありません。 |
NO_INTERFACE_DEF | F | リクエストされた API は定義されていません。 |
REQUEST_TRAFFIC_EXCEED_LIMIT | F | リクエストトラフィックが制限を超えました。 |
PRODUCT_QUOTA_LIMIT | F | 製品の使用量が制限を超えました。 |
SYSTEM_ERROR | U | システムエラーが発生しました。 |
PROCESS_TIMEOUT | F | API リクエストの処理がタイムアウトしました。 |
API 固有のリザルトコード
特定の API に適用されるリザルトコードについては、各 API 仕様の「Result」セクションをご参照ください。
SDK 固有のエラーコード
SDK コールバック結果 クライアント側 SDK の情報については、SDK コールバック結果にのみ焦点を当てる必要があります。
SDK コールバック結果は、`complete` と `interrupt` です。SDK のコールバック結果が `complete` の場合、`checkresult` などのサーバー側 API を呼び出してステータスと結果を取得します。
SDK のコールバック結果が `interrupt` の場合、クライアントにポップアップウィンドウのアラート (ネットワークエラー、タイムアウトなど) が表示されます。SDK はコード (Z で始まる 4 桁の数字) も返し、ユーザーは「Quit」または「Got it」、あるいは SDK を閉じるための他の操作を選択できます。その後、ビジネス要件に応じて、ユーザーにリトライを促したり、人によるレビューを待ったりするなど、後続のプロセスに進むことができます。
SDK 統合の処理
開発者の統合中に SDK がエラーを報告した場合、上記の表を参照してエラーのトラブルシューティングを行うことができます。参照しやすいように、この表には統合中によく遭遇する共通エラーコードのみが含まれています。
SDK が適切に統合され、プロセス全体がスムーズに実行される場合、リターンコードは無視できます。このコードは、お客様からのフィードバックに関して ZOLOZ テクニカルサポートチームがさらにトラブルシューティングを行う場合にのみ使用されます。
SDK コールバック結果
SDK のコールバック結果に注意する必要があります。
SDK の結果には、`complete` と `interrupt` の 2 つがあります。
以下のコールバック内容は、それぞれ Android と iOS の SDK に対応しています。
Android
iOS
SDK 完了
SDK の収集とクライアント側のプロセスが完了した後、サーバー側の `checkresult` インターフェイスを呼び出して、ビジネスステータスと結果を表示する必要があります。
SDK 中断
SDK の収集が中断され、SDK が閉じられます。このコールバック結果を取得すると、操作が終了したことを示します。
中断の場合、サーバー側のステータスは 2 つのケースに分かれます。
ユーザーがキャンセルした場合 (「Quit」または「Got it」をクリック)、サーバーに通知され、サーバーステータスは `cancel` に変更されます。
バックグラウンドでの終了やシステム例外の場合、SDK はそれを感知したりサーバーに通知したりできません。これは、サーバーステータスが `processing` のままであり、SDK のコールバック情報がサーバー側のインターフェイスステータスと競合しないことを意味します。
中断された場合、対応するポップアップウィンドウがクライアントに表示され (ネットワークエラー、タイムアウトなど)、ユーザーは「Quit」または「Got it」、あるいはトランザクションを閉じるための他の操作を選択する必要があります。したがって、ポップアップに応じてテストメソッドを調整できます。
各ポップアップの説明については、以下の「ポップアップウィンドウの説明」をご参照ください。
クライアントエラーのポップアップウィンドウ
これらのポップアップはオンラインのエンドユーザーに表示されます。対応する文言を入力するだけで、各ポップアップのビジネスロジックを処理する必要はありません。
エラーポップアップウィンドウのカスタマイズ
UI 設定プラットフォームでは、すべてのポップアップウィンドウを表示し、各ポップアップのタイトル、文言、ボタンのコンテンツをカスタマイズできます。
ポップアップウィンドウの説明
ポップアップ | デフォルトヘッダー | デフォルトの文言 | 理由 | ボタン |
システムエラー | システムエラー | 申し訳ありませんが、システムエラーが発生しました。後でもう一度お試しください。 | 「Got it」 – ユーザーがボタンをクリックして SDK を終了します | |
ネットワークエラー | インターネット接続の失敗 | インターネット接続を確認して、もう一度お試しください。 | ネットワーク接続の失敗 | 「Quit」 – ユーザーがボタンをクリックして SDK を終了します 「Retry」 – ユーザーがクリックして再度ネットワークに接続しようとします。SDK は終了しません |
カメラへのアクセス失敗 | カメラ権限がありません | アプリケーションにカメラへのアクセスを許可するか、リフレッシュしてもう一度お試しください。 | カメラ権限が付与されていません | 「Quit」 – ユーザーがボタンをクリックして SDK を終了します 「Go to settings」 – ユーザーがクリックしてカメラ権限を付与します。SDK は終了しません |
リトライ回数上限 | 試行回数が多すぎます | 試行回数の上限に達しました。後でもう一度お試しください。 | ユーザーが複数回のドキュメント/顔のスキャンを行い、リトライ回数が設定された上限を超えました。 | 「Quit」 – ユーザーがボタンをクリックして SDK を終了します |
ユーザーによる本人確認の中止 | 本当に終了しますか？ | スキャンしやすいように、ID が鮮明で反射していないことを確認してください。 | ユーザーがクリックしてドキュメントスキャンインターフェイスを終了しました。 | 「Quit」 – ユーザーがボタンをクリックして SDK を終了します 「Retry」 – ユーザーがクリックして再度ドキュメントをスキャンしようとします。SDK は終了しません |
期限切れのドキュメント | ID が期限切れです | ID が期限切れでないことを確認してください。 | 期限切れのドキュメント | 「Quit」 – ユーザーがボタンをクリックして SDK を終了します 「Retry」 – ユーザーがクリックして再度ドキュメントをスキャンしようとします。SDK は終了しません |
ドキュメントで顔が検出されない | 顔写真が不完全です | ドキュメントの顔写真がぼやけているか不完全です。鮮明な写真を撮ってください。 | ドキュメントで顔が検出されません | 「Quit」 – ユーザーがボタンをクリックして SDK を終了します 「Retry」 – ユーザーがクリックして再度ドキュメントをスキャンしようとします。SDK は終了しません |
ドキュメントの露出オーバー | ID の露出オーバー | 露出オーバーを避けるために照明を調整してください。 | ドキュメントが露出オーバーです | 「Quit」 – ユーザーがボタンをクリックして SDK を終了します 「Retry」 – ユーザーがクリックして再度ドキュメントをスキャンしようとします。SDK は終了しません |
ドキュメントが不鮮明 | ID が不鮮明です | ID が完全に表示され、光の反射がなく、ぼやけていないことを確認してください。 | ぼやけたドキュメントは品質テストに合格しません | 「Quit」 – ユーザーがボタンをクリックして SDK を終了します 「Retry」 – ユーザーがクリックして再度ドキュメントをスキャンしようとします。SDK は終了しません |
ドキュメントが不完全 | ID が不完全です | ID が完全に表示され、光の反射がなく、ぼやけていないことを確認してください。 | ドキュメントが完全にキャプチャされておらず、品質テストに合格しません | 「Quit」 – ユーザーがボタンをクリックして SDK を終了します 「Retry」 – ユーザーがクリックして再度ドキュメントをスキャンしようとします。SDK は終了しません |
ドキュメントが違う | 不正な ID タイプが検出されました | 必要なタイプの ID を使用していることを確認してください。 | キャプチャされたドキュメントは、リクエストされたドキュメントのタイプではありません | 「Quit」 – ユーザーがボタンをクリックして SDK を終了します 「Retry」 – ユーザーがクリックして再度ドキュメントをスキャンしようとします。SDK は終了しません |
不明なドキュメント | 不正な ID タイプが検出されました | 必要なタイプの ID を使用していることを確認してください。 | 不明なドキュメントタイプです。キャプチャされたドキュメントは、必要なドキュメントタイプではありません。 | 「Quit」 – ユーザーがボタンをクリックして SDK を終了します 「Retry」 – ユーザーがクリックして再度ドキュメントをスキャンしようとします。SDK は終了しません |
ドキュメントが検出されない | ID が検出されません | 写真を撮る前に、ID をフレームに合わせてください。 | ドキュメントがキャプチャされていません | 「Quit」 – ユーザーがボタンをクリックして SDK を終了します 「Retry」 – ユーザーがクリックして再度ドキュメントをスキャンしようとします。SDK は終了しません |
ユーザーによる顔認証の中止 | 本当に終了しますか？ | キャプチャしやすいように、カメラにまっすぐ向かってください。 | ユーザーが顔キャプチャインターフェイスから退出しました | 「Quit」 – ユーザーがボタンをクリックして SDK を終了します 「Retry」 – ユーザーがクリックして再度顔スキャンを試みます。SDK は終了しません |
顔認証の失敗 | 顔認証に失敗しました | スマートフォンのカメラにまっすぐ向き、顔が明るく鮮明であることを確認してください。 | 顔のキャプチャに失敗しました。ライブキャプチャとドキュメントの顔写真との顔照合が、合格しきい値を満たすほど一致しませんでした。ユーザーは再度顔をキャプチャする必要があります。このエラーはめったに発生しません。 | 「Quit」 – ユーザーがボタンをクリックして SDK を終了します 「Retry」 – ユーザーがクリックして再度顔スキャンを試みます。SDK は終了しません |
顔認証のタイムアウト | 操作のタイムアウト | キャプチャしやすいように、カメラにまっすぐ向かってください。 | 顔スキャンがタイムアウトしました。顔キャプチャの要件を満たすために設定された時間内に顔が検出されませんでした。 | 「Quit」 – ユーザーがボタンをクリックして SDK を終了します 「Retry」 – ユーザーがクリックして再度顔スキャンを試みます。SDK は終了しません |
顔認証の中断 | 顔認証の中断 | キャプチャしやすいように、カメラにまっすぐ向かってください。 | バックグラウンドでのアプリの切り替えなどにより、顔キャプチャプロセスが中断された可能性があります。ユーザーはアプリに再度戻ったときに、リトライ/終了しか選択できません。 | 「Quit」 – ユーザーがボタンをクリックして SDK を終了します 「Retry」 – ユーザーがクリックして再度顔スキャンを試みます。SDK は終了しません |
デバイスがサポートされていません | このデバイスでは顔認証はサポートされていません。 | デバイスがポリシーブラックリストによってブロックされるリスクがあるか、デバイスがカメラをサポートしていないためスキャンやキャプチャができません。このエラーはめったに発生しません。 | 「Got it」 – ユーザーがクリックして SDK を終了します | |
カメラの初期化失敗 | このデバイスでは顔認証はサポートされていません。 | ハードウェアの問題により、デバイスが顔スキャンをサポートしていないため、カメラを起動すると失敗し、ユーザーは続行できません。このエラーはめったに発生しません。 | 「Got it」 – ユーザーがクリックして SDK を終了します | |
ドキュメントカメラの初期化失敗 | このデバイスではドキュメントのキャプチャはサポートされていません。 | ハードウェアの問題により、デバイスがドキュメントスキャンをサポートしていないため、カメラを起動すると失敗し、ユーザーは続行できません。このエラーはめったに発生しません。 | 「Got it」 – ユーザーがクリックして SDK を終了します |
retCode
`retCode` に依存してビジネス処理ロジックを設計しないでください。`retCode` は、クライアント側で例外が発生した場合の問題のトラブルシューティングやデータ分析にのみ適用されます。
Z10XX
retCode | 説明 |
Z1000 | アルゴリズムモデルのエラーまたはシステムエラー (Android) サーバーから発行されたパラメーター解析例外 (bioType エラー) (iOS) |
Z1001 | クライアントアルゴリズムの初期化に失敗しました |
Z1002 | カメラを起動できません |
Z1003 | サポートされていないハードウェア (CPU) |
Z1004 | オペレーティングシステムのバージョンが低すぎます |
Z1005 | 1 回の顔スキャンのタイムアウト |
Z1006 | リトライ回数が上限を超えました |
Z1008 | ユーザーが顔スキャンから能動的に終了しました |
Z1009 | バックグラウンドアプリの切り替え時に終了 |
Z1010 | 内部リフレクションが異常か、対応するページが見つかりません (Android) `zimid` が null です (iOS) |
Z1012 | ネットワークエラー |
Z1013 | 生体検知に失敗しました |
Z1016 | ユーザーがリトライポップアップボックスの終了ボタンをクリックしました |
Z1018 | 前面カメラがありません |
Z1019 | カメラ使用権限がありません |
Z1020 | カメラを開けませんでした |
Z1021 | カメラにイメージストリームがありません |
Z1022 | 内部エラーのため認証が中断されました |
Z1024 | 最後の認証が処理中です |
Z2XXX
retCode | 説明 |
Z2000 | システムエラー |
Z2001 | Android:
iOS:
|
Z2002 | ユーザーが能動的に終了しました |
Z2003 | ネットワーク接続の例外 |
Z2006 | リトライ回数が上限を超えています |
Z2007 | なりすまし防止検知中の失敗により、ユーザーが終了を選択しました |
Z2341 | ドキュメントが検出されません |
Z50XX
retCode | 説明 |
Z5001 | リクエストプロトコルエラー |
Z70XX
retCode | 説明 |
Z7001 | インターネットに接続されていません |
Z7002 | ユーザーが終了を希望しています |
Z7003 | eKYC がコールバック onComplete を呼び出し、結果は Success です (Android のみ) |
Z7005 | eKYC がコールバック onComplete を呼び出し、結果は Pending です (Android のみ) |
Z7010 | clientCfg の戻り値が不正です |
Z7011 | `Context` が null です (Android) `Viewcontroller` が null です (iOS) |
Z7012 | `clientCfg` が null です |
Z7013 | `FLOW_TYPE` が null です |
Z7014 | 設定ファイルがありません |
Z7015 | ファイルの読み取りに失敗しました |
Z7016 | Web サービス設定ファイルがありません (Android のみ) |
Z7017 | リフレクションの失敗 (Android のみ) |
Z7018 | `zimid` が null です |
Z7019 | `bizDataKey` の値が null です |
Z7020 | `zlzconfig` 内の Web タスクの URL が null です |
Z7021 | 現在のタスクは webTask ではありません |
Z7022 | ネットワーク問題以外の RPC 例外 |
Z7023 | H5 キーパラメーターのチェックに失敗しました |
Z7024 | 問題に応じた特定の分析が必要です |
Z7025 | `zimid` キーが null です |
Z7026 | URL パターンが null です |
Z7027 | 設定に URL パターンが見つかりません |
Z7028 | 不正なタスクインデックス |
Z7029 | 不正なタスクタイプ |
Z7030 | 不正なサーバタスク名 |
Z7031 | 不正な設定フォーマット |
Z7032 | `nativeTask` の `zimInitResp` が null です |
Z7033 | webTask の結果処理エラー |
Z7035 | ドキュメントまたは顔の収集に成功しました |
Z7075 | カメラの初期化に失敗しました |
Z7076 | カメラを開けませんでした |
Z7077 | モデルファイルのエラーによりアルゴリズムの初期化に失敗し、ユーザー操作がブロックされます |
Z7078 | サーバーがクライアントに認識できないリターンコードを返しました |
Z90XX
retCode | 説明 |
Z9003 | ZOLOZ CONNECT の認識成功 |
Z9004 | ZOLOZ CONNECT の認識失敗 |