このトピックでは、CheckResult 操作を呼び出して、ID ドキュメント OCR ソリューションから認証結果を取得する方法について説明します。
API の説明
操作名:CheckResult
リクエストメソッド:HTTPS POST
説明:コールバック通知を受信した後、ご利用のサーバーでこの操作を呼び出して認証結果を取得します。
重要ID Verification の結果は、デフォルトで 30 日間保存されます。 この期間を過ぎると、システムによって自動的に削除されます。 認証完了後 30 日以内に認証結果をクエリする必要があります。
各 API 操作には、1 秒あたりのクエリ数 (QPS) の制限があります。 詳細については、「ID Verification サーバーサイド API 操作の QPS 制限」をご参照ください。
エンドポイント:
説明内部ネットワークは、同じリージョン内の Alibaba Cloud プロダクト間のプライベート通信ネットワークです。 ご利用のサービスサーバーがサポートされている Alibaba Cloud リージョンにデプロイされている場合、VPC エンドポイントを介して ID Verification サービスにアクセスすることで、より安全で安定したネットワーク通信が可能になります。
中国 (香港)
パブリックエンドポイント:
cloudauth-intl.cn-hongkong.aliyuncs.comVPC エンドポイント:
cloudauth-intl-vpc.cn-hongkong.aliyuncs.com
オンラインでのデバッグと統合
サーバーサイド API のデバッグと統合を行う前に、「OpenAPI Explorer を使用したサーバーサイド API 操作のデバッグと統合」ドキュメントを読み、API 操作の呼び出し方法、および OpenAPI Explorer での SDK とサンプルコードの取得方法を理解していることを確認してください。
OpenAPI Explorer では、この操作をデバッグし、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-5384FF03**** |
Code | String | 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 写真。 このフィールドは、リクエストで isReturnImage パラメーターを Y に設定し、ID ドキュメント OCR プロセスが正常に完了した場合に返されます。 | base64 |
ocrIdInfo | String | ID ドキュメント OCR からのフィールド情報。 詳細については、「OCR 結果フィールド」をご参照ください。 説明 ID ドキュメント OCR プロセスが失敗した場合、このフィールドは空になります。 | |
spoofInfo | String | ID ドキュメントなりすまし防止チェックの結果。 結果には、リスク判定とリスクタイプが含まれます。 説明 ID ドキュメントのなりすまし防止は、Initialize 操作で IdSpoof を Y に設定した場合にのみ有効になります。 それ以外の場合、spoofResult はデフォルトで N になり、spoofType は空になります。
| |
ocrIdEditInfo | String | ユーザーが OCR 結果ページで編集して送信した ID ドキュメント OCR フィールド情報。 このパラメーターは、クライアントが OCR 結果編集ページ (ShowOcrResult) を有効にするように設定されている場合に返されます。 説明 Web SDK 統合の場合、サーバーサイドの Initialize 操作で ShowOcrResult を設定します。 | |
idBackImage | String | ID ドキュメントの裏面の OCR 写真 (Base64 フォーマット)。 説明 このフィールドは、リクエストで isReturnImage パラメーターを Y に設定し、ID ドキュメント OCR プロセスが正常に完了した場合に返されます。 | base64 |
ocrIdBackInfo | String | ID ドキュメントの裏面からの OCR フィールド情報。 重要 ID ドキュメント OCR プロセスが失敗した場合、このフィールドは空になります。 | |
spoofBackInfo | String | ID ドキュメントの裏面のなりすまし防止チェックの結果。 結果には、リスク判定とリスクタイプが含まれます。 説明 ID ドキュメントのなりすまし防止は、Initialize 操作で 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 | 発行機関 |
グローバルパスポート
この ID ドキュメントタイプでは、サービスは国際民間航空機関 (ICAO) 準拠の eパスポートの機械読み取り領域 (MRZ) の内容を認識し、パスポートフィールドを標準化されたフォーマットで出力します。 このアプローチにより、さまざまな国の異なるデータページフォーマットによって引き起こされる可能性のある互換性の問題を防ぎます。
フィールド | タイプ | 説明 |
surname | String | 姓 (ラテン文字、MRZ 認識に基づく) |
givenname | String | 名 (ラテン文字、MRZ 認識に基づく) |
sex | String | 性別 (F または M) |
birthDate | String | 生年月日 (yyyy-mm-dd フォーマット) |
passportNo | String | パスポート番号 |
nationality | String | 国籍 (3 桁の国コード) |
expiryDate | String | 有効期限 (yyyy-mm-dd フォーマット) |
countryCode | String | パスポート発行機関の国コード (3 桁の国 国コード |
マカオ住民 ID カード
フィールド | タイプ | 説明 |
surnameCN | String | 姓 (中国語) |
givennameCN | String | 名 (中国語) |
surname | String | 姓 (英語) |
givenname | String | 名 (英語) |
sex | String | 性別 |
birthDate | String | 生年月日 |
idNumber | String | 証明書番号 |
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 | 住所 |