ID_OCR_MAX は、ID Verification が提供する ID ドキュメント認識ソリューションです。Qwen-VL モデルを使用して、世界中のさまざまな ID ドキュメントタイプを検出および認識します。
サポートされるドキュメントタイプは、リージョンのモデル制限により、リージョンによって異なります。
シンガポールおよび中国 (香港) リージョン:ドキュメントタイプの表に記載されているドキュメントタイプに対応しています。
インドネシア (ジャカルタ) リージョン:インドネシア ID カードとグローバルパスポート (ドキュメントタイプコード
IDN01001およびGLB03002) のみをサポートします。マレーシア (クアラルンプール) リージョン:マレーシア ID カードとグローバルパスポート (ドキュメントタイプコード
MYS01001およびGLB03002) のみをサポートします。
サービスエンドポイント
API 操作:DocOcrMaxV2
説明:Qwen-VL モデルを使用してドキュメントタイプを認識し、ドキュメント画像から情報を抽出して、関連するフィールドを返します。
リクエストメソッド:POST
トランスポートプロトコル:HTTPS
QPS 制限:各 API には専用の QPS 制限があります。詳細は、「ID Verification サーバー側 API の QPS 制限」をご参照ください。
サービスエンドポイント:
説明内部ネットワークアクセスのメリット:内部ネットワークを使用すると、同じリージョン内の Alibaba Cloud サービス間でプライベートな通信が可能になります。ご利用のアプリケーションサーバーも同じリージョンにある場合は、内部ネットワークエンドポイントを使用して ID Verification サービスにアクセスすることで、より安全で安定した接続が実現します。
海外アクセスの最適化:中国本土以外のネットワーク環境は複雑な場合があります。遅延を減らし、リクエストの失敗を最小限に抑えるには、「サーバー側のネットワーク遅延分析と最適化」のベストプラクティスに従って統合を最適化してください。
シンガポール
パブリックエンドポイント:
cloudauth-intl.ap-southeast-1.aliyuncs.com内部エンドポイント:
cloudauth-intl-vpc.ap-southeast-1.aliyuncs.com
中国 (香港)
パブリックエンドポイント:
cloudauth-intl.cn-hongkong.aliyuncs.com内部エンドポイント:
cloudauth-intl-vpc.cn-hongkong.aliyuncs.com
インドネシア (ジャカルタ)
パブリックエンドポイント:
cloudauth-intl.ap-southeast-5.aliyuncs.com内部エンドポイント:
cloudauth-intl-vpc.ap-southeast-5.aliyuncs.com
マレーシア (クアラルンプール)
パブリックエンドポイント:
cloudauth-intl.ap-southeast-3.aliyuncs.com内部エンドポイント:
cloudauth-intl-vpc.ap-southeast-3.aliyuncs.com
オンラインデバッグと統合
デバッグまたは統合を行う前に、「OpenAPI を使用したサーバー側 API のデバッグと統合」ガイドを読み、OpenAPI プラットフォームでの API の呼び出し方法と SDK の取得方法を理解してください。
この操作をデバッグし、 SDK サンプルコードを OpenAPI Explorerで生成できます。
画像要件
モデルのパフォーマンスを安定させるために、次の要件を満たす画像を使用してください。
サポートされる画像フォーマット:JPG、JPEG、PNG。
画像サイズ:推奨サイズは 50 KB ~ 100 KB です。最大サイズは 10 MB です。
説明画像を base64 フォーマットに変換すると、通常データサイズが大きくなります。画像を base64 エンコードされた文字列として渡す場合、10 MB のデータ転送制限内に収まるように、元の画像サイズが 6 MB を超えないようにしてください。
画像解像度:画像のディメンションは 200~8,192 ピクセルの範囲内である必要があります。推奨解像度は 480 × 640 (高さ × 幅) です。
画質の推奨事項:
カード画像の四隅すべてが見えるようにしてください。カードの一部でも隠れていると、検出に影響する可能性があります。
カード画像は鮮明で、向きが正しく、遮蔽物や光の反射がないようにしてください。
カードは画像全体の 60% 以上を占める必要があります。カードの領域が小さすぎると、認識に影響が出る可能性があります。
実際の物理的なドキュメントの写真を使用してください。
リクエストパラメーター
パラメーター | タイプ | 必須 | 説明 | 例 |
ProductCode | String | はい | 使用するプロダクトソリューション。値を ID_OCR_MAX に設定します。 | ID_OCR_MAX |
SceneCode | String | いいえ | カスタム認証シナリオ ID。この ID を使用して、コンソールで関連レコードをクエリできます。 ID には、英字、数字、アンダースコア (_) の組み合わせを最大 10 文字まで使用できます。 | 1234567890 |
MerchantBizId | String | はい | カスタム一意ビジネス ID。この ID を使用して、問題を追跡およびトラブルシューティングできます。 ID は一意である必要があり、英字と数字の組み合わせを最大 32 文字まで使用できます。 | e0c34a77f5ac40a5aa5e6ed20c35**** |
MerchantUserId | String | いいえ | カスタムユーザー ID、または携帯電話番号やメールアドレスなどの特定のユーザーの別の識別子。 渡す前に、ハッシュ化するなどして、この値を非機密化することを強く推奨します。 | 123456789 |
IdOcrPictureBase64 | String | いいえ。3 つの画像アップロード方法のいずれかが必要です。 | ID ドキュメントの base64 エンコードされた画像。 | base64 |
IdOcrPictureUrl | String | ID ドキュメント画像の URL。URL は、公開アクセス可能な HTTP または HTTPS リンクである必要があります。 | https://***.jpg | |
IdOcrPictureFile | InputStream | ID ドキュメント画像のファイルストリーム。 | 具体的な統合方法については、「Advance インターフェースによるファイルのアップロード」をご参照ください。 | |
OcrModel | String | いいえ | OCR 認識モード: 説明 モード 1 および 2 は、ドキュメントの偽造防止検出をサポートしていません。詳細については、「認識モードの違い」をご参照ください。
| 0 |
DocType | String | いいえ | [OCR 設定] ドキュメントコードまたは国/地域コード。国/地域コードを渡す場合、最大 3 つのコード (例:CHN、HKG、GLB) を指定して、自動分類の範囲を定義できます。システムは、この範囲内でサポートされているドキュメントタイプを自動的に取得し、認識が成功した後に特定のドキュメントコードを返します。 サポートされている国/地域のドキュメントコードについては、「ドキュメントタイプ」表をご参照ください。各ドキュメントタイプで返される OCR フィールドについては、「ドキュメント OCR フィールド」表をご参照ください。 重要 サポートされるドキュメントタイプは、リージョンのモデル制限により、リージョンによって異なります。
| GLB03001 |
DocPage | String | いいえ | 認識するページ:
重要 検出されたページが指定されたページと一致しない場合、サービスは Subcode 213 を返します。 | 01 |
IdSpoof | String | いいえ | ドキュメントなりすまし検知を有効にするかどうかを指定します:
| F |
IdThreshold | String | いいえ | OCR カード品質チェック:
| 3 |
OcrValueStandard | String | いいえ | 標準化された形式で追加の OCR フィールドを返すかどうかを指定します:
説明 サポートされているドキュメントタイプと標準化されたフィールドの詳細については、「フィールドの標準化」をご参照ください。 | 0 |
認識モードの違い
OCR 認識モード | 入力の違い | 出力の違い | 推奨されるユースケース |
0:指定ドキュメント認識モード |
| 詳細なドキュメントフィールドを出力します。詳細については、「ドキュメント OCR フィールド」をご参照ください。 | ドキュメントタイプの検証と詳細フィールドの抽出が必要なオンラインでのユーザーオンボーディング。 |
1:自動ドキュメント分類モード 重要 この認識モードは、シンガポールリージョンでのみサポートされています。 |
| 検出されたドキュメントタイプコード (例: CHN01) のみを出力します。詳細については、「グローバル ID ドキュメントコード」をご参照ください。 | 履歴 ID ドキュメント画像のクラスタリングとクリーンアップのためのオフラインビジネス分析シナリオ。 |
2:自動ドキュメント分類および一般認識モード 重要 この認識モードは、シンガポールリージョンでのみサポートされています。 |
| ドキュメントから、ドキュメントタイプコード (例: CHN01) と主要な共通フィールドを出力します。詳細については、「汎用認識フィールドの表」をご参照ください。 説明 | ドキュメントタイプと主要フィールドの認識によりレビュー効率を向上できる、オフラインでの手動レビュー支援シナリオ。 |
3:国/地域コードによる自動ドキュメント分類および指定ドキュメント認識モード |
| ドキュメントコード (たとえば、 CHN01001) と詳細なドキュメントフィールドを出力します。詳細については、「ドキュメント OCR フィールド」をご参照ください。 | 特定の国または地域の複数のドキュメントタイプの検証と詳細フィールドの抽出が必要なオンラインでのユーザーオンボーディング。 |
レスポンスパラメーター
パラメーター | タイプ | 説明 | 例 | |
HTTP ステータスコード | Integer | HTTP ステータスコード。 | 200 | |
HTTP Body | RequestId | String | リクエスト ID。 | 130A2C10-B9EE-4D84-88E3-5384F******** |
Result.TransactionId | String | 認証プロセス全体の一意のトランザクション ID。 | hksb7ba1b28130d24e015d694******** | |
Code | String | 結果コードです。詳細については、「サーバーサイド HTTP ステータスコード」をご参照ください。 | Success | |
Message | String | Code パラメーターの詳細な説明。 | success | |
Result.Passed | String | 認識が成功したかどうかを示します。 | Y | |
Result.SubCode | String | 200 | ||
Result.ExtIdInfo | String | ドキュメント OCR となりすまし防止検出の結果。詳細については、「ExtIdInfo」をご参照ください。 |
| |
ExtIdInfo
パラメーター | タイプ | 説明 | 例 |
ocrDocType | String | ドキュメントタイプコード または ドキュメントコード。 説明
| CHN01 |
ocrIdInfo | String | ID ドキュメントから抽出された OCR フィールドデータ。 説明
|
|
spoofInfo | String | ドキュメントなりすまし検知の結果。リスク判定とリスクタイプが含まれます。 説明 なりすまし検知は、IdSpoof = T の場合にのみ有効です。 それ以外の場合、spoofResult は N を返し、spoofType は空です。
| |
ocrStandardData | String | ID ドキュメントから抽出された標準化された OCR フィールドデータ。 説明 このフィールドは、ドキュメントタイプがサポートされ、かつ | |
Result.SubCode エラーコード
エラーコード | 課金対象 | 説明と推奨事項 |
200 | はい | 認証が成功しました。 |
211 | はい | [ドキュメントソリューション] 画像の品質または解像度が要件を満たしていないか、画像が不完全です。ドキュメント画像が鮮明で、適切に露出され、完全で、遮るものがなく、正しい向きであることを確認してください。 |
212 | はい | [ドキュメントソリューション] ドキュメントなりすまし検知がリスクを検出しました。考えられる原因には、画面の再撮影、改ざん、またはフォトコピーが含まれます。 |
213 | はい | [ドキュメントソリューション] 指定されたドキュメントタイプが検出されませんでした (指定ドキュメント認識モードの場合)、またはドキュメントタイプを識別できませんでした (自動分類モードの場合)。 鮮明で、完全で、正しい向きのドキュメント画像を提供してください。 |