このトピックでは、ID ドキュメント画像から情報を自動的に抽出し、なりすまし防止のリスク評価を実行する DocOcrV2 API のサーバーサイド統合について説明します。
API 詳細
API: DocOcrV2
リクエストメソッド: HTTPS POST
説明: パスポートや ID カードなど、さまざまな ID ドキュメントから情報を抽出し、なりすまし防止チェックを実行します。
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 サンプルコードを生成できます。
画像形式の要件
モデルのパフォーマンスを安定させるため、次のすべての条件を満たす画像を提供してください。
サポートされる画像フォーマット:JPG、JPEG、PNG。
サイズ: 推奨サイズは 50 KB ~ 100 KB です。最大サイズは 1 MB です。
説明画像を base64 フォーマットに変換すると、通常データサイズが大きくなります。画像を base64 エンコードされた文字列として渡す場合、10 MB のデータ転送制限内に収まるように、元の画像サイズが 6 MB を超えないようにしてください。
画像解像度:画像のディメンションは 200~8,192 ピクセルの範囲内である必要があります。推奨解像度は 480 × 640 (高さ × 幅) です。
画質の推奨事項:
カード画像の四隅すべてが見えるようにしてください。カードの一部でも隠れていると、検出に影響する可能性があります。
カード画像は鮮明で、向きが正しく、遮蔽物や光の反射がないようにしてください。
カードは画像全体の 60% 以上を占める必要があります。カードの領域が小さすぎると、認識に影響が出る可能性があります。
実際の物理的なドキュメントの写真を使用してください。
リクエストパラメータ
パラメータ | タイプ | 必須 | 説明 | 例 |
ProductCode | String | はい | 使用する製品プラン。ID ドキュメント OCR API の場合は、値を ID_OCR_MIN に設定します。 | ID_OCR_MIN |
SceneCode | String | いいえ | コンソールで関連レコードをクエリするために使用できるカスタム認証シナリオ ID。ID は最大 10 文字で、英字、数字、アンダースコア (_) を含めることができます。 | 1234567890 |
MerchantBizId | String | はい | 追跡とトラブルシューティングのための、カスタムの一意なビジネス ID。ID は、最大 32 文字の英字と数字の文字列にすることができます。この ID がリクエストごとに一意であることを確認してください。 説明 Alibaba Cloud サーバーは、このフィールドの一意性をチェックしません。効果的な追跡のため、ID が一意であることを確認することを強く推奨します。 | e0c34a77f5ac40a5aa5e6ed20c35**** |
MerchantUserId | String | はい | 電話番号やメールアドレスなどのカスタムユーザー識別子。送信前に、ハッシュ化などを使用してこの値をマスクすることを強く推奨します。 | 123456789 |
IdOcrPictureBase64 | String | いいえ。3 つのアップロード方法のいずれかを選択してください。 | ID ドキュメントの base64 エンコードされた画像。この方法を使用する場合は、データ転送制限を超えないように画像サイズを確認してください。 | base64 |
IdOcrPictureUrl | String | ID ドキュメント画像の公開アクセス可能な HTTP または HTTPS URL。 | https://*** | |
IdOcrPictureFile | InputStream | ID ドキュメント画像のファイルストリーム。 | 統合手順については、「特別なシナリオ: Advance インターフェースによるファイルアップロード」をご参照ください。 | |
DocType | String | はい | 8 桁の一意な識別子で指定するドキュメントタイプです。詳細については、「ドキュメントタイプ」をご参照ください。 | 01000000 |
Spoof | String | いいえ | [OCR 設定] なりすまし防止機能を有効にするかどうかを指定します。 説明 このパラメータは、ID ドキュメントの顔写真面に対してのみ有効です。
| F |
IdThreshold | String | いいえ | OCR カード品質チェック:
| 3 |
CardSide | String | いいえ | [OCR 設定] 認識する ID ドキュメントの面。デフォルトは顔写真面です。
重要 このパラメータは、中華人民共和国の居民身分証にのみ適用されます。 | OCR_ID_NATIONAL_EMBLEM |
ドキュメントタイプ
DocType | ドキュメント |
01000000 | グローバルパスポート |
00000006 | 香港身分証明書 (2003 年版) |
00000008 | 香港身分証明書 (2018 年版) |
00000007 | 往来港澳通行証 |
00000009 | 港澳居民来往内地通行証 |
00000011 | マカオ特別行政区居民身分証 |
00000012 | 台湾居民来往大陸通行証 |
00000001 | 中国本土の第二世代居民身分証 |
レスポンスパラメータ
パラメータ | タイプ | 説明 | 例 | |
HTTP Status Code | Integer | HTTP ステータスコード。 | 200 | |
HTTP Body | RequestId | String | リクエスト ID。 | 130A2C10-B9EE-4D84-88E3-5384FF039**** |
Result.TransactionId | String | 認証プロセス全体の一意 ID。 | hksb7ba1b28130d24e015d694361b**** | |
Code | String | レスポンスコード。詳細については、「サーバーサイド HTTP ステータスコード」をご参照ください。 | Success | |
Message | String | レスポンスコードの詳細な説明。 | success | |
Result.Passed | String | 認証結果。有効な値:
| Y | |
Result.SubCode | String | 認証結果の説明。詳細については、「Result.SubCode エラーコード」をご参照ください。 | 200 | |
Result.ExtIdInfo | String | ID ドキュメント認識結果。JSON 形式については、右側の例をご参照ください。詳細については、「ExtIdInfo」をご参照ください。 | | |
ExtIdInfo
パラメータ | タイプ | 説明 | 例 |
ocrIdInfo | String | ID ドキュメントから抽出された情報。詳細については、「ID Document OCR Fields (for Chinese-funded overseas enterprises)」をご参照ください。 説明 OCR プロセスが失敗した場合、このフィールドは空になります。 | |
spoofInfo | String | なりすまし防止検出結果。リスク判定と検出されたリスクタイプが含まれます。 説明 なりすまし検出は、Spoof パラメータが T に設定されている場合にのみ実行されます。 それ以外の場合、spoofResult は N を返し、spoofType は空になります。
| |
Result.SubCode エラーコード
エラーコード | 課金対象 | 説明と提案 |
200 | はい | 認証に成功しました。 |
212 | はい | ドキュメントなりすまし防止検知でリスクが検出されました。これは、画面再撮影、改ざん、コピーなどのリスクの高いアクティビティが原因である可能性があります。 |
213 | はい | システムが指定されたドキュメントタイプを検出しなかったか (指定ドキュメント認識モード)、ドキュメントタイプを識別できませんでした (自動分類モード)。 鮮明で完全な、正しい向きのドキュメント画像を提供してください。 |