このトピックでは、CheckResult 操作を呼び出して、ドキュメント光学式文字認識 ( OCR ) リクエストの検証結果を照会する方法について説明します。
使用上の注意
操作名: CheckResult
エンドポイント: cloudauth-intl.cn-hongkong.aliyuncs.com
リクエストメソッド: HTTPS POST
操作の説明: コールバック通知を受信した後、この操作を呼び出して ID Verification から検証リクエストの結果を取得できます。
QPS 制限: API の 1 秒あたりのクエリ数 ( QPS ) には制限があります。 詳細については、「ID Verification - KYC サーバーサイド API の QPS 制限」をご参照ください。
リクエストパラメーター
パラメーター | タイプ | 必須 | 説明 | 例 |
MerchantBizId | String | はい | ビジネスのカスタム一意識別子。トラブルシューティングに使用されます。 32 文字の長さで、文字と数字を含むカスタム値を指定できます。 値が一意であることを確認してください。 説明 ID Verification は、値の一意性をチェックしません。追跡のため、一意の値を指定することをお勧めします。 | e0c34a77f5ac40a5aa5e6ed20c35**** |
トランザクション ID | 文字列 | はい | 検証プロセスの固有識別子です。 Initialize 操作を呼び出して値を取得できます。 | hksb7ba1b28130d24e015d694361**** |
IsReturnImage | String | いいえ | 検証に使用されるイメージを返すかどうかを指定します。有効な値:
| Y |
レスポンスパラメーター
パラメーター | タイプ | 説明 | 例 | |
HTTP ステータスコード | Integer | HTTP ステータスコード。 | 200 | |
HTTP 本文 | RequestId | String | リクエスト ID。 | 130A2C10-B9EE-4D84-88E3-5384FF03**** |
Code | String | リクエストに対して返されるコード。 詳細については、この Topic の「コードとメッセージの説明」セクションをご参照ください。 | 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 | ドキュメント認識によって返されるフィールド。詳細については、「ドキュメント認識によって返されるフィールド」をご参照ください。 説明 ドキュメント検証に失敗した場合、このパラメーターは空です。 |
|
spoofInfo | String | リスク識別結果とリスクタイプを含む、偽造防止検出の結果: 説明 カード検出は、初期化 操作で IdSpoof = Y を設定した場合にのみ有効になります。 それ以外の場合、spoofResult はデフォルトで N を返し、spoofType は空です。
|
|
ocrIdEditInfo | String | お客様が OCR 結果を再編集した後に提出する証明書の OCR フィールドに関する情報。この機能を無効にするには、アカウント マネージャーに連絡してください。 |
|
idBackImage | String | ドキュメント OCR イメージの裏面 (Base64 形式)。 説明 このパラメーターは、リクエストで isReturnImage = Y を設定し、ドキュメント OCR プロセスが完了した場合に返されます。 | Base64 |
ocrIdBackInfo | String | ドキュメントの裏面についてドキュメント認識によって返されるフィールド。 重要 ドキュメント検証に失敗した場合、このパラメーターは空です。 |
|
spoofBackInfo | String | リスク識別結果とリスクタイプを含む、偽造防止検出の結果: 説明 カード検出は、初期化 操作で IdSpoof = Y を設定した場合にのみ有効になります。 それ以外の場合、spoofResult はデフォルトで N を返し、spoofType は空です。
説明 これはアルゴリズム予測結果です。このパラメーターは返されない場合があります。ビジネスで必要な依存関係を設定しないことをお勧めします。 |
|
コードとメッセージの説明
HTTP ステータスコード | コード | メッセージ |
200 | Success | リクエストは成功しました。 |
400 | MissingParameter | 必須パラメーターが空のままです。 |
InvalidParameter | パラメーターに無効な値が設定されています。 | |
TransactionIdInvalid | トランザクション ID が無効です。 | |
403 | Forbidden.RAMUserAccessDenied | 必要なポリシー AliyunAntCloudAuthFullAccess が RAM ユーザーにアタッチされていません。 詳細については、「RAM ユーザーに ID Verification - KYC へのアクセスを承認する」をご参照ください。 |
Forbidden.AccountAccessDenied | ID Verification が有効になっていないか、アカウントの支払いが滞っています。 | |
Throttling.Api | API スロットリングがトリガーされました。 | |
404 | ProcessNotCompleted | 確認プロセスが完了していません。 |
500 | InternalError | 内部エラーが発生しました。 エラーのトラブルシューティングについては、テクニカルサポートに連絡することをお勧めします。 |
ResultObject.SubCode のコード
該当するソリューション | エラーコード | 課金対象 | 原因と提案 |
すべて | 200 | はい | お客様は認証に合格しました。 |
| 211 | はい | ドキュメント画像の品質または解像度が要件を満たしていないか、画像が不完全です。ドキュメントの個人情報ページの画像が鮮明で完全であり、カバーがなく、画像の露出レベルが正常であり、画像が大きく傾いていないことを確認してください。 |
| 212 | はい | ドキュメントの偽造防止検出の結果、写真やドキュメントのコピー、改ざんされたドキュメントなどのリスクが示されています。 |
| 213 | はい | ドキュメントが検出されませんでした。ドキュメント画像は、アップロードされたドキュメントの種類と一致する必要があります。 |
レスポンスパラメーター
香港(中国)の身分証明書
2003 年版と 2018 年版の身分証明書がサポートされています。
フィールド | タイプ | 説明 |
name | String | 名前。 |
englishName | String | 英語での名前。 |
nameCode | String | 中国語の名前コード。 |
sex | String | 性別。有効な値:
|
birthDate | String | 生年月日。 |
idNumber | String | 身分証明書番号。 |
currentIssueDate | String | 登録日。 |
firstIssueDate | String | 初回登録年月。 |
isPermanent | String | 身分証明書が永住権であるかどうかを示します。有効な値:
|
symbols | String | 備考。例: "**AZ"。 |
香港・マカオへの出入国許可証
フィールド | タイプ | 説明 |
name | String | 名前。 |
englishName | String | ピンイン表記の名前。 |
sex | String | 性別。 |
birthDate | String | 生年月日。 |
idNumber | String | ID カード番号。 |
issueDate | String | 発行日。 |
expiryDate | String | 有効期限。 |
placeOfIssue | String | 発行場所。 |
originOfIssue | String | 発行機関。 |
香港・マカオ居民往来内地通行証
フィールド | タイプ | 説明 |
name | String | 名前。 |
englishName | String | 英語表記の名前。 |
sex | String | 性別。 |
birthDate | String | 生年月日。 |
idNumber | String | ID カード番号。 |
issueDate | String | 発行日。 |
expiryDate | String | 有効期限。 |
originOfIssue | 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 | ID カード番号。 |
expiryDate | String | 有効期限。 |
placeOfBirth | String | 出生地のコード。例: "AS"。 |
台湾居民来往大陸通行証
フィールド | タイプ | 説明 |
name | String | 名前。 |
englishName | String | ピンイン表記の名前。 |
sex | String | 性別。 |
birthDate | String | 生年月日。 |
idNumber | String | ID カード番号。 |
issueDate | String | 発行日。 |
expiryDate | String | 有効期限。 |
originOfIssue | String | 発行機関。 |
placeOfIssue | String | 発行場所。 |
中国本土居住者の身分証明書
フィールド | タイプ | 説明 |
name | String | 名前。 |
sex | String | 性別。 |
ethnicity | String | 民族。 |
birthDate | String | 生年月日。 |
idNumber | String | 身分証明書番号。 |
address | String | 住所。 |