API の呼び出し時にエラーが発生した場合、エラー応答が返されます。その際、結果フィールドはエラーコード ( 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 に適用される結果コードについては、結果 セクション。
SDK 固有のエラーコード
SDK コールバック結果 クライアント側 SDK の情報については、SDK コールバック結果のみに注目してください。
SDK コールバック結果は、complete と interrupt です。
SDK コールバック結果が complete の場合は、サーバー側 API (例: checkresult) を呼び出して、ステータスと結果を取得します。
SDK コールバック結果が interrupt の場合は、ポップアップウィンドウアラートがクライアントに表示されます (例: ネットワークエラー、タイムアウトなど)。SDK はコード (Z で始まる 4 桁の数字) も返します。ユーザーは「終了」または「了解」を選択するか、その他の操作で SDK を閉じることができます。その後、ビジネス要件に従って後続の処理 (ユーザーに再試行を促す、人的レビューを待つなど) を続行できます。
SDK 統合の処理
開発者統合中に SDK がエラーを報告した場合は、上記の表を参照してエラーのトラブルシューティングを行うことができます。参照しやすいように、表には統合中に発生する頻度の高い共通エラーコードのみが含まれています。
SDK が正しく統合され、プロセス全体がスムーズに実行される場合は、リターンコードは無視できます。コードは、顧客からのフィードバックに関して ZOLOZ テクニカルサポートチームが詳細なトラブルシューティングを行う場合にのみ使用されます。
SDK コールバック結果
SDK コールバック結果に注意する必要があります。SDK の結果は、 と の 2 つです。完了 および 割り込み。
次のコールバックコンテンツは、それぞれ Android SDK と iOS SDK に対応しています。
Android
iOS
SDK Complete
SDK の収集とクライアント側プロセスが完了したら、サーバー側の checkresult インターフェースを呼び出して、ビジネスステータスと結果を確認する必要があります。
SDK Interrupt
SDK の収集が中断され、SDK が閉じられます。このコールバック結果を取得すると、操作が終了したことが示されます。
中断が発生した場合、サーバー側のステータスは次の 2 つのケースに分けられます。
ユーザーが (「終了」または「了解」をクリックして) キャンセルした場合、サーバーに通知され、サーバーのステータスがキャンセルに変更されます。
バックグラウンドでの終了またはシステム例外が発生した場合、SDK はそれを認識したり、サーバーに通知したりすることができません。つまり、サーバーのステータスは引き続き処理中になり、SDK コールバック情報はサーバー側インターフェースのステータスと競合しません。
中断された場合は、クライアントに対応するポップアップ ウィンドウ (ネットワーク エラー、タイムアウトなど) が表示され、ユーザーはトランザクションを閉じるために「終了」または「了解」オプション、あるいはその他の操作を選択する必要があります。そのため、テスト メソッドはポップアップに応じて調整できます。
各ポップアップの説明については、以下の ポップアップウィンドウの説明 を参照してください。
クライアントエラー ポップアップウィンドウ
これらの ポップアップはオンラインの C 側ユーザーに表示されます。対応するコピーを入力するだけで、各 ポップアップのビジネスロジックを処理する必要はありません。
エラー ポップアップウィンドウのカスタマイズ
UI構成プラットフォームでは、すべてのポップアップウィンドウを表示し、各ポップアップのタイトル、コピー、ボタンのコンテンツをカスタマイズできます。
ポップアップウィンドウの説明
ポップアップ | デフォルトヘッダー | デフォルトコピー | 理由 | ボタン |
システムエラー | システムエラー | 申し訳ありませんが、システムエラーが発生しました。後でもう一度お試しください。 | "了解しました" – ユーザーがボタンをクリックして SDK を終了します | |
ネットワークエラー | インターネット接続エラー | インターネット接続を確認して、もう一度お試しください。 | インターネット接続エラー | "Quit" – ユーザーがボタンをクリックして SDK を終了します 「再試行」- ユーザーがクリックしてネットワークへの再接続を試みます。SDK は終了しません |
カメラアクセスエラー | カメラの権限がありません | アプリケーションがカメラにアクセスすることを許可するか、リフレッシュしてもう一度お試しください。 | カメラの権限が承認されていません | "Quit" – ユーザーがボタンをクリックして SDK を終了します "設定に移動" – ユーザーがクリックしてカメラの権限を承認します。SDK は終了しません |
再試行制限に達しました | 試行回数が多すぎます | 試行回数の制限に達しました。後でもう一度お試しください。 | ユーザーがドキュメント / 顔のスキャンを複数回行っており、再試行回数が設定された制限を超えています。 | "Quit" – ユーザーがボタンをクリックして SDK を終了します |
ユーザーが ID 認識を終了しました | 終了しますか？ | ID が鮮明で反射していないことを確認して、スキャンしやすくしてください。 | ユーザーがドキュメントスキャンインターフェースを終了するためにクリックしました。 | "Quit" – ユーザーが [ボタン] をクリックして SDK を終了します 「再試行」- ユーザーがクリックしてドキュメントの再スキャンを試みます。SDK は終了しません |
ドキュメントの期限が切れました | ID の期限切れ | ID が期限切れでないことを確認してください。 | 期限切れのドキュメント | "Quit" – ユーザーがボタンをクリックして SDK を終了します 「再試行」- ユーザーがクリックしてドキュメントの再スキャンを試みます。SDK は終了しません |
ドキュメントで顔が検出されませんでした | ポートレートが不完全です | ドキュメントのポートレートがぼやけているか不完全です。鮮明な写真を撮ってください。 | ドキュメントで顔が検出されませんでした | "Quit" – ユーザーが [ボタン] をクリックし、SDK を終了します 「再試行」- ユーザーがクリックしてドキュメントの再スキャンを試みます。SDK は終了しません |
ドキュメントが露出オーバーです | ID の露出オーバー | 露出オーバーにならないように照明を調整してください。 | ドキュメントが露出オーバーです | "Quit" – ユーザーがボタンをクリックして SDK を終了します 「再試行」- ユーザーがクリックしてドキュメントの再スキャンを試みます。SDK は終了しません |
ドキュメントが鮮明ではありません | ID が鮮明ではありません | ID が完全に表示され、グレアがなく、ぼやけていないことを確認してください。 | ぼやけたドキュメントは品質テストに合格しません | "Quit" – ユーザーが [ボタン] をクリックして SDK を終了します 「再試行」- ユーザーがクリックしてドキュメントの再スキャンを試みます。SDK は終了しません |
ドキュメントが完全ではありません | ID が完全ではありません | ID が完全に表示され、グレアがなく、ぼやけていないことを確認してください。 | ドキュメントが完全にキャプチャされておらず、品質テストに合格しません | "Quit" – ユーザーが [ボタン] をクリックして SDK を終了します 「再試行」- ユーザーがクリックしてドキュメントの再スキャンを試みます。SDK は終了しません |
間違ったドキュメント | 誤った ID タイプが検出されました | 必要なタイプの ID を使用していることを確認してください。 | キャプチャされたドキュメントは、リクエストされたドキュメントタイプではありません | "Quit" – ユーザーが [ボタン] をクリックして SDK を終了します 「再試行」- ユーザーがクリックしてドキュメントの再スキャンを試みます。SDK は終了しません |
不明なドキュメント | 誤った ID タイプが検出されました | 必要なタイプの ID を使用していることを確認してください。 | 不明なドキュメントタイプです。キャプチャされたドキュメントは、必要なドキュメントタイプではありません。 | "Quit" – ユーザーが [ボタン] をクリックして SDK を終了します 「再試行」- ユーザーがクリックしてドキュメントの再スキャンを試みます。SDK は終了しません |
ドキュメントが検出されませんでした | ID が検出されませんでした | 写真を撮る前に、ID をフレームに合わせます。 | ドキュメントがキャプチャされていません | "Quit" – ユーザーが [ボタン] をクリックして SDK を終了します 「再試行」- ユーザーがクリックしてドキュメントの再スキャンを試みます。SDK は終了しません |
ユーザーが顔認識を終了しました | 終了しますか？ | 撮影しやすいように、カメラに顔をまっすぐ向けてください。 | ユーザーが顔キャプチャインターフェースをタップアウトしました | "Quit" – ユーザーがボタンをクリックして SDK を終了します 「再試行」- ユーザーがクリックして顔の再スキャンを試みます。SDK は終了しません |
顔認識エラー | 顔認証に失敗しました | スマートフォンのカメラに顔を向けて、顔が明るくはっきりと見えるようにしてください。 | 顔キャプチャに失敗しました。ライブキャプチャとドキュメントのポートレートの顔照合が、合格しきい値を満たすのに十分一致していません。ユーザーは顔を再キャプチャする必要があります。このエラーはめったに発生しません。 | "Quit" – ユーザーがボタンをクリックして SDK を終了します 「再試行」- ユーザーがクリックして顔の再スキャンを試みます。SDK は終了しません |
顔認識タイムアウト | 操作タイムアウト | 撮影しやすいように、カメラに顔をまっすぐ向けてください。 | 顔スキャンがタイムアウトしました。設定された時間枠内に顔が検出されず、顔キャプチャの要件を満たしていません。 | "Quit" – ユーザーが [ボタン] をクリックして SDK を終了します 「再試行」- ユーザーがクリックして顔の再スキャンを試みます。SDK は終了しません |
顔認識の中断 | 顔認証の中断 | 撮影しやすいように、カメラに顔をまっすぐ向けてください。 | バックグラウンドでのアプリの切り替えなどにより、顔キャプチャプロセスが中断された可能性があります。ユーザーは、アプリに再び戻ったときにのみ、再試行 / 終了を選択できます。 | "Quit" – ユーザーが [ボタン] をクリックして SDK を終了します 「再試行」- ユーザーがクリックして顔の再スキャンを試みます。SDK は終了しません |
デバイスはサポートされていません | このデバイスでは顔認証はサポートされていません。 | デバイスはポリシーのブラックリストによってブロックされるリスクがあります。または、デバイスがカメラをサポートしていないため、スキャンまたはキャプチャを実行できません。このエラーはほとんど発生しません。 | 「了解」- ユーザーがクリックして SDK を終了します | |
カメラの初期化に失敗しました | このデバイスでは顔認証はサポートされていません。 | ハードウェアの問題により、デバイスは顔認証をサポートしていません。そのため、カメラを起動しても失敗し、ユーザーは先に進むことができません。このエラーはほとんど発生しません。 | 「了解」- ユーザーがクリックして SDK を終了します | |
ドキュメントカメラの初期化に失敗しました | このデバイスではドキュメントキャプチャはサポートされていません。 | ハードウェアの問題により、デバイスはドキュメントのスキャンをサポートしていません。そのため、カメラを起動すると失敗し、ユーザーは続行できません。このエラーはほとんど発生しません。 | 「了解」- ユーザーがクリックして 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 | コンテキストが 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 認識失敗 |