ドキュメント 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 を取得する方法を理解してください。
この API は OpenAPI Explorer で実行してデバッグし、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 | ID ドキュメントの Base64 エンコードされたイメージ。 | base64 |
ocrIdInfo | String | OCR によって ID ドキュメントから抽出されたフィールド。詳細については、「OCR の戻りフィールド」をご参照ください。 説明 イメージが読み取れない場合や、ID ドキュメントの OCR が完全に失敗した場合は、空になることがあります。 | |
spoofInfo | String | ID ドキュメントのなりすまし防止チェックの結果。リスク判定とリスクタイプが含まれます。 説明 ID ドキュメントのなりすまし防止は、Initialize API で IdSpoof = Y が設定されている場合にのみ有効になります。 それ以外の場合、spoofResult はデフォルトで N になり、spoofType は空になります。
| |
ocrIdEditInfo | String | ユーザーが編集した ID ドキュメントの OCR データ。クライアントが OCR 編集ページ (ShowOcrResult) を表示した場合にのみ返されます。 | |
idBackImage | String | ID ドキュメントの裏面の Base64 エンコードされたイメージ。 説明 このフィールドは、isReturnImage = Y パラメーターが設定され、ID ドキュメントの OCR が成功した場合にのみ返されます。 | base64 |
ocrIdBackInfo | String | OCR によって ID ドキュメントの裏面から抽出されたフィールド。 重要 このフィールドは、イメージが読み取れない場合や、ID ドキュメントの OCR が完全に失敗した場合は、空になることがあります。 | |
spoofBackInfo | String | ID ドキュメントの裏面のなりすまし防止チェックの結果。リスク判定とリスクタイプが含まれます。 説明 ID ドキュメントのなりすまし防止は、Initialize API で IdSpoof = Y が設定されている場合にのみ有効になります。 それ以外の場合、spoofResult はデフォルトで N になり、spoofType は空になります。
説明 これはアルゴリズムによる予測であり、常に返されるとは限りません。ビジネスロジックでこのフィールドに必須の依存関係を作成しないでください。 | |
ResultObject.SubCode のエラーコード
Subcode は、プロダクトソリューションや統合方法によって返されます。詳細については、次の表をご参照ください。
適用ソリューション | エラーコード | 認証レコードは課金対象か | 説明と推奨される理由 |
一般 | 200 | はい | 認証合格。 |
| 211 | はい | 証明書イメージの品質または解像度が要件を満たしていないか、イメージ自体が不完全です。証明書の顔写真側の写真が鮮明で、露出が正常で、遮蔽がなく完全であり、大きな角度のずれがないことを確認してください。 |
| 212 | はい | 証明書の偽造防止検出でリスクが示されています。再撮影、改ざん、写真コピーなどの高リスク操作の可能性があります。 |
| 213 | はい | 指定された証明書タイプが検出されなかった (認識モード) か、証明書タイプを識別できませんでした (分類モード)。 鮮明で完全な、角度が正常な証明書イメージをアップロードすることを推奨します。 |
OCR レスポンスフィールド
香港永久性居民身分証
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 | 発行機関 |
台湾住民大陸通行証
パラメーター | 型 | 説明 |
name | String | 氏名 |
englishName | String | 氏名 (ピンイン) |
sex | String | 性別 |
birthDate | String | 生年月日 |
idNumber | String | ドキュメント番号 |
issueDate | String | 発行日 |
expiryDate | String | 有効期限 |
originOfIssue | String | 発行機関 |
placeOfIssue | String | 発行地 |
eパスポート
このドキュメントタイプは、ICAO 準拠の eパスポートの機械読み取り領域 (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 | ドキュメント番号 |
expiryDate | String | 有効期限 |
placeOfBirth | String | 出生地コード。例:「***AZ」。 |
中国本土 ID カード
パラメーター | 型 | 説明 |
name | String | 氏名 |
sex | String | 性別 |
ethnicity | String | 民族 |
birthDate | String | 生年月日 |
idNumber | String | ID 番号 |
address | String | 住所 |
province | String | 省 説明 予約済みフィールド。デフォルトでは空を返します。 |
city | String | 市 説明 予約済みフィールド。デフォルトでは空を返します。 |
originOfIssue | String | 発行機関 |
issueDate | String | 発行日 |
expiryDate | String | 有効期限 |