CheckResult 操作を呼び出して、ドキュメント OCR リクエストの検証結果を照会します。
API
操作名:CheckResult
リクエストメソッド:HTTPS POST
説明:コールバック通知を受信した後、ご利用のサーバーからこの操作を呼び出して検証結果を取得します。
重要ID Verification はデフォルトで検証結果を 30 日間保存し、その後自動的に削除します。この 30 日間の期間内に検証結果を照会してください。
QPS 制限:各 API には専用の QPS 制限があります。詳細については、「ID Verification サーバー側 API の QPS 制限」をご参照ください。
サービスエンドポイント:
説明内部ネットワークアクセスのメリット:内部ネットワークを使用すると、同一リージョン内の 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 | はい | 追跡およびトラブルシューティング用の一意のビジネス識別子です。この値は、最大 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 | リターンコード:詳細については、「サーバー側 HTTP ステータスコード」をご参照ください。 | Success | |
Message | String | 応答メッセージ。 | success | |
Result.Passed | String | 認証が成功したかどうかを示します。有効な値:
| Y | |
Result.SubCode | String | 詳細な認証結果コード。詳細については、「ResultObject.SubCode エラーコードの説明」をご参照ください。 | 200 | |
Result.ExtIdInfo | String | ID ドキュメント OCR 結果。JSON 文字列として返されます。 右側の例を参照してください。詳細については、「ExtIdInfo」をご参照ください。 | | |
ExtIdInfo
パラメーター | タイプ | 説明 | 例の値 |
ocrIdPassed | String | ID OCR 処理の結果:
| N |
idImage | String | Base64 エンコードされた ID OCR 写真。このフィールドは、 | base64 |
ocrIdInfo | String | ID OCR フィールド情報。詳細については、「OCR 返却フィールド」をご参照ください。 説明 ID OCR 処理が失敗した場合、このフィールドは空になります。 | |
spoofInfo | String | なりすまし検出結果を含み、リスク判定およびリスクタイプが含まれます: 説明 カード検出は、Initialize 操作で IdSpoof が Y に設定されている場合にのみ有効になります。 それ以外の場合、spoofResult はデフォルトで N となり、spoofType は空になります。
| |
ocrIdEditInfo | String | OCR 結果ページでユーザーが編集した ID OCR フィールド情報。ShowOcrResult が有効になっている場合に返されます。 説明 Web SDK 統合の場合、ShowOcrResult はサーバー側 Initialize API 呼び出しで設定されます。 | |
idBackImage | String | Base64 エンコードされた ID 裏面の写真。 説明 このフィールドは、isReturnImage パラメーターが Y に設定され、かつ ID OCR が成功した場合に返されます。 | base64 |
ocrIdBackInfo | String | ID 裏面の OCR フィールド情報。 重要 ID OCR 処理が失敗した場合、このフィールドは空になります。 | |
spoofBackInfo | String | ID 裏面のなりすまし検出結果を含み、リスク判定およびリスクタイプが含まれます: 説明 カード検出は、Initialize 操作で IdSpoof が Y に設定されている場合にのみ有効になります。 それ以外の場合、spoofResult はデフォルトで N となり、spoofType は空になります。
説明 このフィールドはアルゴリズムによる予測に基づいており、常に返されるとは限りません。ビジネスロジックでこのフィールドにハード依存を作成しないでください。 | |
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 | 永住者向けカードかどうかを示します。有効な値:
|
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 | 許可証を発行した機関。 |
グローバルパスポート
このドキュメントタイプは、ICAO 準拠の電子パスポートの機械読取領域(MRZ)を認識します。国ごとのフォーマットの違いによる互換性の問題を軽減するために、パスポートフィールドを標準フォーマットで返します。
フィールド | タイプ | 説明 |
surname | String | MRZ から認識されたラテン文字表記の姓。 |
givenName | String | MRZ から認識されたラテン文字表記の名。 |
sex | String | 所持者の性別: |
birthDate | String |
|
passportNo | String | パスポート番号。 |
nationality | String | 所持者の国籍を表す 3 文字の国別コード。 |
expiryDate | String |
|
countryCode | String | 発行国の 3 文字コード。 |
マカオ居民身分証
フィールド | タイプ | 説明 |
surnameCN | String | カードの名義人の漢字表記の姓。 |
givenNameCN | String | カードの名義人の漢字表記の名。 |
surname | String | カードの名義人の英語表記の姓。 |
givenName | String | カードの名義人の英語表記の名。 |
sex | String | カードの名義人の性別。 |
birthDate | String | カードの名義人の生年月日。 |
idNumber | String | ID カード番号。 |
expiryDate | String | カードの有効期限。 |
placeOfBirth | String | 出生地を表すコード(例:「AS」)。 |
台湾居民往来大陸通行証
フィールド | タイプ | 説明 |
name | String | 所持者の氏名。 |
englishName | String | 所持者の氏名(ピンイン表記)。 |
sex | String | 所持者の性別。 |
birthDate | String | 所持者の生年月日。 |
idNumber | String | 許可証番号。 |
issueDate | String | 許可証の発行日。 |
expiryDate | String | 許可証の有効期限。 |
originOfIssue | String | 許可証を発行した機関。 |
placeOfIssue | String | 許可証の発行場所。 |
中華人民共和国住民身分証
フィールド | タイプ | 説明 |
name | String | カードの名義人の氏名。 |
sex | String | カードの名義人の性別。 |
ethnicity | String | カードの名義人の民族。 |
birthDate | String | カードの名義人の生年月日。 |
idNumber | String | ID カード番号。 |
address | String | カードの名義人の住所。 |