このトピックでは、CheckResult API 操作を呼び出して、ドキュメント OCR ソリューションの認証結果をクエリする方法について説明します。
説明
API 操作: CheckResult
リクエストメソッド: HTTPS POST
説明: コールバック通知を受信した後、サーバーでこの API 操作を呼び出して認証結果を取得します。
重要デフォルトでは、ID Verification サービスの結果は 30 日間保存されます。この期間が過ぎると、システムは自動的にそれらを削除します。認証完了後 30 日以内に認証結果をクエリする必要があります。
QPS 制限: この API は、排他的な 1 秒あたりのクエリ数 (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 Explorer を使用してサーバーサイド API 操作をデバッグおよび統合する」ドキュメントをお読みください。このドキュメントでは、OpenAPI プラットフォームで API 操作を呼び出す方法と、SDK およびそのサンプルコードを取得する方法について説明しています。
OpenAPI Explorer を使用してこの API 操作を直接デバッグし 、 SDK コード例を生成できます。
リクエストパラメーター
名前 | タイプ | 必須 | 説明 | 例 |
MerchantBizId | String | はい | 追跡やトラブルシューティングに使用できる、カスタムの一意のビジネス識別子です。最大 32 文字の英数字の組み合わせにすることができます。一意であることを確認してください。 説明 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-5384FF03**** |
Code | String | Success | ||
Message | String | 応答コードの詳細な説明。 | success | |
Result.Passed | String | 最終的な認証結果。有効な値:
| Y | |
Result.SubCode | String | 認証結果の説明。詳細については、 「ResultObject.SubCode エラーコード」をご参照ください。 | 200 | |
Result.ExtIdInfo | String | ドキュメント OCR 結果に関する情報。 JSON フォーマットについては、右の例をご参照ください。詳細については、「ExtIdInfo」をご参照ください。 | | |
ExtIdInfo
名前 | タイプ | 説明 | 例 |
ocrIdPassed | String | ドキュメント OCR ステージの最終結果:
| N |
idImage | String | Base64 フォーマットのドキュメント OCR 写真。このフィールドは、リクエストで IsReturnImage パラメーターを Y に設定し、ドキュメント OCR プロセスが正常に完了した場合に返されます。 | base64 |
ocrIdInfo | String | ドキュメント OCR フィールド情報。詳細については、「OCR 認識応答フィールド」をご参照ください。 説明 ドキュメント OCR プロセスが失敗した場合、このフィールドは空になります。 | |
spoofInfo | String | リスク評価結果とリスクタイプを含む、ドキュメントのなりすまし防止検出結果: 説明 カード検出は、Initialize API 操作で 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 | リスク評価結果とリスクタイプを含む、ドキュメントのなりすまし防止検出結果: 説明 カード検出は、Initialize API 操作で IdSpoof = Y の場合にのみ有効になります。 それ以外の場合、spoofResult はデフォルトで N を返し、spoofType は空になります。
説明 これはアルゴリズムの予測結果です。このフィールドは返されない場合があります。ビジネスでこのフィールドに必須の依存関係を設定することは避けてください。 | |
リターンコード
HTTP ステータスコード | コード | メッセージ |
200 | Success | リクエストは成功しました。 |
400 | MissingParameter | パラメーターを空にすることはできません。 |
InvalidParameter | 無効なパラメーターです。 | |
TransactionIdInvalid | 無効なトランザクション ID。 | |
403 | Forbidden.RAMUserAccessDenied | RAM ユーザーに AliyunAntCloudAuthFullAccess 権限を付与する必要があります。詳細については、「RAM ユーザーにサービスへのアクセスを承認する」をご参照ください。 |
Forbidden.AccountAccessDenied | ID Verification を有効にし、アカウントに支払い遅延がないことを確認してください。 | |
Throttling.Api | スロットリングのため API リクエストがブロックされました。 | |
404 | ProcessNotCompleted | 認証プロセス全体が完了していません。 |
500 | InternalError | 内部システムエラー。トラブルシューティングのためにエンジニアにフィードバックを提供してください。 |
ResultObject.SubCode エラーコード
Subcode は、さまざまなプロダクトソリューションまたは統合メソッドに基づいて返されます。詳細については、次の表をご参照ください。
適用可能なソリューション | エラーコード | 認証レコードは課金されますか | 説明と推奨される理由 |
一般 | 200 | はい | 認証に合格しました。 |
| 211 | はい | 証明書イメージの品質または解像度が要件を満たしていないか、イメージ自体が不完全です。証明書の縦向きの面の写真が鮮明で、露出が正常で、遮蔽物がなく完全であり、大きな角度のずれがないことを確認してください。 |
| 212 | はい | 証明書の偽造防止検出でリスクが示されました。再撮影、改ざん、写真コピーなどの高リスクな操作が行われた可能性があります。 |
| 213 | はい | 指定された証明書タイプが検出されなかった (認識モード) か、証明書タイプを識別できませんでした (分類モード)。 鮮明で完全な、角度が正常な証明書イメージをアップロードすることをお勧めします。 |
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 | 有効期限 |