このトピックでは、CheckResult 操作を使用して eKYC ソリューションの検証結果をクエリする方法について説明します。
API の説明
API 操作: CheckResult
リクエストメソッド: HTTPS POST
説明: コールバック通知を受信した後、サーバーでこの API 操作を呼び出して、認証ステータスと資料を取得できます。
重要ID Verification サービスの結果は、デフォルトで 30 日間保存され、この期間が過ぎると自動的に削除されます。認証完了後 30 日以内に認証結果をクエリする必要があります。
API 固有の QPS 制限については、「ID Verification サーバーサイド API の QPS 制限」をご参照ください。
エンドポイント:
説明内部の同一リージョンエンドポイントは、同一リージョン内の Alibaba Cloud プロダクト間の通信に使用されます。ビジネスサーバーが対応する Alibaba Cloud リージョンにデプロイされている場合は、内部の同一リージョンエンドポイントを介して ID Verification サービスにアクセスすると、より安全で安定したネットワーク通信が可能になります。
中国 (香港)
パブリックエンドポイント:
cloudauth-intl.cn-hongkong.aliyuncs.com内部の同一リージョンエンドポイント:
cloudauth-intl-vpc.cn-hongkong.aliyuncs.com
オンラインでのテストと統合
デバッグと統合を開始する前に、「OpenAPI を使用してサーバーサイド API をデバッグおよび統合する」ドキュメントを確認して、OpenAPI プラットフォームで API 操作を呼び出し、SDK とサンプルコードを取得する方法を学習してください。
OpenAPI Explorer を使用してこの API 操作を直接呼び出してデバッグし、SDK コード例を生成できます。
リクエストパラメーター
名前 | タイプ | 必須 | 説明 | 例 |
MerchantBizId | String | はい | カスタマイズする一意のビジネス ID。問題の追跡とトラブルシューティングに使用されます。ID は文字と数字の組み合わせで、長さは 32 文字である必要があります。ID が一意であることを確認してください。 説明 Alibaba Cloud サーバーはこのフィールドの一意性をチェックしません。追跡を改善するために、このフィールドの一意性を確保することを強くお勧めします。 | e0c34a77f5ac40a5aa5e6ed20c35**** |
TransactionId | String | はい | 認証フロー全体の一意の識別子。この値を取得するには、Initialize API 操作を呼び出す必要があります。 重要 改ざんを防ぐには、Initialize API 操作の呼び出しからサーバーに保存されている TransactionId を使用する必要があります。クライアント側のコールバックからの TransactionId は使用しないでください。 | hksb7ba1b28130d24e015d6******** |
IsReturnImage | String | いいえ | 認証イメージ資料を返すかどうかを指定します。
| Y |
応答パラメーター
名前 | タイプ | 説明 | 例 | |
HTTP ステータスコード | Integer | HTTP ステータスコード。 | 200 | |
HTTP 本文 | RequestId | String | リクエスト ID。 | 130A2C10-B9EE-4D84-88E3-5384FF039795 |
Code | String | Success | ||
Message | String | 応答コードの詳細な説明。 | success | |
Result.Passed | String | 最終的な認証結果。有効な値:
| Y | |
Result.SubCode | String | 認証結果の説明。詳細については、「ResultObject.SubCode のエラーコード」をご参照ください。 | 200 | |
Result.ExtFaceInfo | String | 顔のライブネス検証に関する結果情報。JSON フォーマットについては、右側の例をご参照ください。詳細については、「ExtFaceInfo」をご参照ください。 | | |
Result.ExtIdInfo | String | 証明書 OCR に関する結果情報。 JSON フォーマットについては、右側の例をご参照ください。詳細については、「ExtIdInfo」をご参照ください。 | | |
応答コード
HTTP ステータスコード | コード | メッセージの説明 |
200 | Success | リクエストは成功しました。 |
400 | MissingParameter | パラメーターは空にできません。 |
InvalidParameter | 無効なパラメーター。 | |
TransactionIdInvalid | 無効なトランザクション ID。 | |
403 | Forbidden.RAMUserAccessDenied | RAM ユーザーに AliyunAntCloudAuthFullAccess 権限を付与する必要があります。詳細については、「RAM ユーザーにサービスへのアクセスを承認する」をご参照ください。 |
Forbidden.AccountAccessDenied | ID 検証を有効にし、アカウントに支払い遅延がないことを確認してください。 | |
Throttling.Api | API リクエストは速度制限によりブロックされています。 | |
404 | ProcessNotCompleted | 認証プロセス全体が完了していません。 |
500 | InternalError | 内部システムエラー。トラブルシューティングのためにエンジニアにフィードバックを提供してください。 |
ResultObject.SubCode のエラーコード
エラーコード | 認証レコードは課金されますか | 説明と推奨される理由 |
200 | はい | 認証に成功しました。 |
201 | はい | 公式データベースで名前と ID カードが一致しません。ユーザーの情報が間違っているか、偽物である可能性があります。ユーザーに確認して再試行するよう提案してください。 |
202 | はい | 公式データベースに ID 情報が見つかりません。手動レビューオプションを提供することをお勧めします。 |
204 | はい | ライブネスの顔と証明書の写真が一致しません。これは、人物と証明書の不一致またはライブネス写真の品質が低いことが原因である可能性があります。 |
205 | はい | ライブネス検出でリスクが示されました。 |
206 | はい | ビジネスポリシーの制限。セーフモードが有効になっている場合、認証デバイスと環境でセキュリティチェックが実行されます。リスクが検出された場合、認証結果は失敗します。 次の方法でトラブルシューティングできます。
|
207 | はい | 公式データベースでの顔検証に失敗しました。これは、別人であるか、ライブネス写真の品質が低いことが原因である可能性があります。 |
209 | はい | 権威ある比較ソースの例外。 |
212 | はい | 証明書の偽造防止検出でリスクが示されました。再撮影、改ざん、コピーなどの高リスクな操作が行われた可能性があります。 |
ExtFaceInfo
名前 | タイプ | 説明 | 例 |
facePassed | String | 顧客が顔のライブネス検証に合格したかどうかを示します。有効な値:
| Y |
faceComparisonScore | Double | キャプチャされた顔画像とドキュメント上の顔画像の類似度スコア。スコアの範囲は 0 から 100 です。 説明 スコアが高いほど、2 つの顔が同一人物に属する確率が高くなります。デフォルトのしきい値は 90 です。ビジネスサンプルデータに基づいてしきい値をカスタマイズできます。 | 99.99 |
faceImg | String | キャプチャされた顔画像の Base64 フォーマット。このパラメーターは、リクエストで | Base64 エンコードされた画像 |
faceAttack | String | 顔キャプチャ中にライブネス攻撃が検出されたかどうかを示します。 有効な値:
| N |
faceQuality | Double | 顔画像の品質スコア。スコアの範囲は 0 から 100 です。 | 99.99 |
faceOcclusion | String | 顔が隠されているかどうかを示します。有効な値:
| N |
docVideoUrl | String | Object Storage Service (OSS) 内の証拠ビデオのダウンロード URL。 説明
| https://aliyun-cloudauth.oss-aliyuncs.com/******.webm |
faceAge | String | 顔画像に基づいて予測された個人の年齢。予測に失敗した場合、このパラメーターは返されません。 | 30 |
faceGender | String | 顔画像に基づいて予測された個人の性別。予測に失敗した場合、このパラメーターは返されません。有効な値:
| M |
authorityComparisonScore | Double | キャプチャされた顔画像と公式の権威あるデータソースからの顔画像の類似度スコア。スコアの範囲は 0 から 100 です。 説明
| 99.99 |
faceAttackScore | Double | 顔認識アルゴリズムによって予測された偽顔攻撃の確率。スコアが高いほど、偽顔の確率が高くなります。 スコアの範囲は 0 から 100 です。 | 80 |
guardRiskScore | Double | フェイスガードアルゴリズムによって予測されたデバイスリスクの確率。スコアが高いほど、デバイスリスクが高くなります。 スコアの範囲は 0 から 100 です。 | 90 |
ExtIdInfo
名前 | タイプ | 説明 | 例 |
ocrIdPassed | String | 証明書 OCR フェーズの最終結果。
| N |
idImage | String | 証明書 OCR 写真の Base64 フォーマット。このフィールドは、リクエストで isReturnImage パラメーターを Y に設定し、証明書 OCR プロセスが完了した場合に返されます。 | Base64 フォーマット |
ocrIdInfo | String | 証明書 OCR フィールド情報。 説明 証明書 OCR プロセスが失敗した場合、このフィールドは空になります。 | |
spoofInfo | String | 偽造防止検出の結果。リスク識別結果とリスクタイプを含みます: 説明 カード検出は、Initialize 操作で IdSpoof = Y を設定した場合にのみ有効になります。 それ以外の場合、spoofResult はデフォルトで N を返し、spoofType は空になります。
| |
ocrIdEditInfo | String | OCR 結果ページでユーザーが編集して送信した証明書 OCR フィールド情報。これは、クライアントが OCR 結果編集ページ (ShowOcrResult) を有効にするように設定されている場合に返されます。 | |
idBackImage | String | 証明書の裏面の OCR 写真 (Base64 フォーマット)。 説明 このフィールドは、リクエストで isReturnImage = Y パラメーターを設定し、証明書 OCR プロセスが完了した場合に返されます。 | base64 |
ocrIdBackInfo | String | 証明書の裏面からの OCR フィールド情報。 重要 証明書 OCR プロセスが失敗した場合、このフィールドは空になります。 | |
spoofBackInfo | String | 証明書の偽造防止検出の結果。脅威判定結果と脅威タイプを含みます:
説明 これはアルゴリズムの予測結果です。このフィールドは返されない場合があります。ビジネスでこのフィールドに必須の依存関係を設定しないことをお勧めします。 | |
ドキュメント認識によって返されるフィールド
香港 (中国) ID カード
2003 年版と 2018 年版の両方のスマート ID カードがサポートされています。
フィールド | タイプ | 説明 |
name | String | 氏名。 |
englishName | String | 英語名。 |
nameCode | String | 漢字氏名コード。 |
sex | String | 性別。有効な値:
|
birthDate | String | 生年月日。 |
idNumber | String | ID カード番号。 |
currentIssueDate | String | 登録日。 |
firstIssueDate | String | 初回登録年月。 |
isPermanent | String | ID カードが永住者 ID カードかどうかを示します。有効な値:
|
symbols | String | 備考。例: "***AZ"。 |
香港・マカオ往来通行証
フィールド | タイプ | 説明 |
name | String | 氏名。 |
englishName | String | ローマ字氏名。 |
sex | String | 性別。 |
birthDate | String | 生年月日。 |
idNumber | String | ID カード番号。 |
issueDate | String | 発行日。 |
expiryDate | String | 有効期限。 |
placeOfIssue | String | 発行地。 |
originOfIssue | String | 発行機関。 |
香港・マカオ住民用中国本土渡航許可証
フィールド | タイプ | 説明 |
name | String | 氏名。 |
englishName | String | ローマ字氏名。 |
sex | String | 性別。 |
birthDate | String | 生年月日。 |
idNumber | String | ID カード番号。 |
issueDate | String | 発行日。 |
expiryDate | String | 有効期限。 |
originOfIssue | String | 発行機関。 |
台湾住民用中国本土渡航許可証
フィールド | タイプ | 説明 |
name | String | 氏名。 |
englishName | String | ローマ字氏名。 |
sex | String | 性別。 |
birthDate | String | 生年月日。 |
idNumber | String | ID カード番号。 |
issueDate | String | 発行日。 |
expiryDate | String | 有効期限。 |
originOfIssue | String | 発行機関。 |
placeOfIssue | String | 発行地。 |
グローバルパスポート
フィールド | タイプ | 説明 |
surname | String | 姓。 |
givenname | String | 名。 |
sex | String | 性別。 |
birthDate | String | 生年月日。 |
passportNo | String | パスポート番号。 |
nationality | String | 国籍。 |
expiryDate | String | 有効期限。 |
countryCode | String | 国コード。 |
マカオ (中国) 住民 ID カード
フィールド | タイプ | 説明 |
surnameCN | String | 漢字姓。 |
givennameCN | String | 中国語での名。 |
surname | String | 英語姓。 |
givenname | String | 英語名。 |
sex | String | 性別。 |
birthDate | String | 生年月日。 |
idNumber | String | ID カード番号。 |
expiryDate | String | 有効期限。 |
placeOfBirth | String | 出生地コード。例: "AS"。 |
中華人民共和国住民 ID カード
フィールド | タイプ | 説明 |
name | String | 氏名。 |
sex | String | 性別。 |
ethnicity | String | 民族。 |
birthDate | String | 生年月日。 |
idNumber | String | ID カード番号。 |
address | String | 住所。 |
province | String | 居住州。 説明 これは予約済みのフィールドであり、デフォルトでは空です。 |
city | String | 居住市。 説明 これは予約済みのフィールドであり、デフォルトでは空です。 |
originOfIssue | String | 発行機関。 |
issueDate | String | 発行日。 |
expiryDate | String | 有効期限。 |