このトピックでは、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
オンラインでのデバッグと統合
API 操作をデバッグして統合する前に、「OpenAPI Explorer を使用したサーバーサイド API 操作のデバッグと統合」で、API 操作の呼び出し方法、および OpenAPI Explorer で SDK とサンプルコードを取得する方法をご参照ください。
この API 操作は OpenAPI Explorer でデバッグ実行し、 SDK コード例を生成できます。
リクエストパラメーター
名前 | タイプ | 必須 | 説明 | 例 |
MerchantBizId | String | はい | カスタマイズする一意のビジネス ID です。問題の追跡とトラブルシューティングに使用されます。ID は英数字の組み合わせで、長さは 32 文字である必要があります。ID が一意であることを確認してください。 説明 Alibaba Cloud サーバーは、このフィールドの一意性をチェックしません。追跡を改善するために、このフィールドの一意性を確保することを強く推奨します。 | e0c34a77f5ac40a5aa5e6ed20c35**** |
TransactionId | String | はい | 認証フロー全体の一意の識別子です。Initialize API 操作を呼び出してこの値を取得します。 重要 改ざんを防ぐため、Initialize 操作を呼び出すときは、クライアントサイドのコールバックによって返された 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 | 証明書認識の結果に関する情報。 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 | 内部システムエラーです。トラブルシューティングのためにエンジニアにフィードバックを提供してください。 |
503 | ServiceUnavailable | サービスは利用できません。トラブルシューティングのためにエンジニアにお問い合わせください。 |
ResultObject.SubCode のエラーコード
エラーコード | 認証レコードは課金されますか? | 説明と提案 |
200 | はい | 認証に合格しました。 |
201 | はい | 氏名と ID カード番号が公式データベースの情報と一致しません。ユーザー情報が不正確または虚偽である可能性があります。ユーザーに情報を確認の上、再試行するよう促してください。 説明 このエラーコードは、プロダクトで検証される証明書タイプが中国の ID カードであり、権威検証機能が有効になっている場合にのみ返されます。 |
202 | はい | 公式データベースで ID 情報が見つかりません。手動レビュープロセスを設定してください。 説明 このエラーコードは、プロダクトで検証される証明書タイプが中国の ID カードであり、権威検証機能が有効になっている場合にのみ返されます。 |
204 | はい | ライブネス顔と証明書の写真が一致しません。これは、人物が証明書と一致しないか、ライブネス写真の品質が低いためである可能性があります。 |
205 | はい | ライブネス検出で脅威が示されました。 |
206 | はい | ビジネスポリシーの制限。セーフモードが有効な場合、認証デバイスと環境に対してセキュリティチェックが実行されます。脅威が検出された場合、認証は失敗します。 トラブルシューティングのために、以下の手順を実行できます:
|
207 | はい | 公式データベースでの顔認証に失敗しました。これは、人物が同一でないか、ライブネス写真の品質が低いためである可能性があります。 説明 このエラーコードは、プロダクトで検証される証明書タイプが中国の ID カードであり、権威検証機能が有効になっている場合にのみ返されます。 |
209 | はい | 権威ある比較ソースが異常です。 説明 このエラーコードは、プロダクトで検証される証明書タイプが中国の ID カードであり、権威検証機能が有効になっている場合にのみ返されます。 |
212 | はい | 証明書の偽造防止検出で脅威が示されました。再撮影、改ざん、コピーなどのリスクのある操作が行われた可能性があります。 |
ExtFaceInfo (eKYC)
名前 | タイプ | 説明 | 例 |
facePassed | String | 顔のライブネス検証の最終結果。
| Y |
faceComparisonScore | Double | キャプチャされた顔と証明書の顔との顔照合の類似度スコア。値の範囲は 0 から 100 です。 説明 スコアが高いほど、顔が同一人物である確率が高くなります。デフォルトのしきい値は 90 です。ご利用のビジネスデータに基づいてしきい値をカスタマイズすることもできます。 | 99.99 |
faceImg | String | キャプチャされた顔画像の Base64 形式。このフィールドは、リクエストで | Base64 形式 |
faceAttack | String | キャプチャされた顔でライブネス攻撃が検出されたかどうかを示します。 Y:攻撃が検出されました。N:攻撃は検出されませんでした。 | N |
faceOcclusion | String | 顔が覆われているかどうかを示します。Y:顔は覆われています。N:顔は覆われていません。 | 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 | Face-Guard アルゴリズムによって予測されたデバイスリスクの確率。スコアが高いほど、デバイスリスクが高くなります。 値の範囲は 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 | 証明書のなりすまし防止検出の結果。脅威の判定結果と脅威タイプを含みます:
説明 これはアルゴリズムの予測結果です。このフィールドは返されない場合があります。ビジネスで必須の依存関係を設定しないことを推奨します。 | |
OCR によって返されるフィールド
香港 (中国) ID カード
2003年版と2018年版の両方のスマート ID カードがサポートされています。
フィールド | タイプ | 説明 |
name | String | 氏名 |
englishName | String | 英語氏名 |
nameCode | String | 漢字氏名コード |
sex | String | 性別。有効な値:
|
birthDate | String | 生年月日 |
idNumber | String | ID カード番号 |
currentIssueDate | String | 登録日 |
firstIssueDate | String | 初回登録年月 |
isPermanent | String | 永住者用 ID カードかどうかを示します。有効な値:
|
symbols | String | 記号マーク。例: "***AZ"。 |
香港・マカオ往来通行証
フィールド | タイプ | 説明 |
name | String | 氏名 |
englishName | String | ピンイン名 |
sex | String | 性別 |
birthDate | String | 生年月日 |
idNumber | String | 証明書番号 |
issueDate | String | 発行日 |
expiryDate | String | 有効期限 |
placeOfIssue | String | 発行地 |
originOfIssue | String | 発行機関 |
香港・マカオ住民内地通行証
フィールド | タイプ | 説明 |
name | String | 氏名 |
englishName | String | 英語氏名 |
sex | String | 性別 |
birthDate | String | 生年月日 |
idNumber | String | 証明書番号 |
issueDate | String | 発行日 |
expiryDate | String | 有効期限 |
originOfIssue | String | 発行機関 |
台湾居民来往大陸通行証
フィールド | タイプ | 説明 |
name | String | 氏名 |
englishName | String | ピンイン名 |
sex | String | 性別 |
birthDate | String | 生年月日 |
idNumber | String | 証明書番号 |
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 | 証明書番号 |
expiryDate | String | 有効期限 |
placeOfBirth | String | 出生地コード。例: "AS"。 |
中華人民共和国居民身分証
フィールド | タイプ | 説明 |
name | String | 氏名 |
sex | String | 性別 |
ethnicity | String | 民族 |
birthDate | String | 生年月日 |
idNumber | String | ID カード番号 |
address | String | 住所 |
province | String | 省 説明 これは予約フィールドであり、デフォルトでは空です。 |
city | String | 市 説明 これは予約フィールドであり、デフォルトでは空です。 |
originOfIssue | String | 発行機関 |
issueDate | String | 発行日 |
expiryDate | String | 有効期限 |