ID_OCR_MAX は、Qwen-VL 大規模モデルを使用して、世界中のさまざまな種類の身分証明書を検出および認識する ID Verification ソリューションです。
インドネシアリージョンでは、この API 操作はインドネシアの ID カード (ドキュメントタイプコード IDN01001) のみの認識をサポートしています。
エンドポイント
API 操作: DocOcrMax
説明: Qwen-VL 大規模モデルを使用してドキュメントタイプを認識し、身分証明書画像から情報を抽出し、関連フィールドを返します。
リクエストメソッド: POST
トランスポートプロトコル: HTTPS
QPS 制限: この API は、専用の 1 秒あたりのクエリ数 (QPS) 制限の対象となります。詳細については、「ID Verification サーバーサイド API の QPS 制限」をご参照ください。
エンドポイント:
説明内部ネットワークは、同一リージョン内の Alibaba Cloud プロダクト間のプライベートな通信ネットワークです。アプリケーションサーバが Alibaba Cloud リージョンにデプロイされている場合、内部エンドポイントを使用して ID Verification サービスにアクセスできます。これにより、より安全で安定したネットワーク接続が提供されます。
シンガポール
パブリックエンドポイント:
cloudauth-intl.ap-southeast-1.aliyuncs.com同一リージョン内の内部エンドポイント:
cloudauth-intl-vpc.ap-southeast-1.aliyuncs.com
インドネシア
パブリックエンドポイント:
cloudauth-intl.ap-southeast-5.aliyuncs.com同一リージョン内の内部エンドポイント:
cloudauth-intl-vpc.ap-southeast-5.aliyuncs.com
オンラインでのデバッグと統合
デバッグと統合を行う前に、「OpenAPI Explorer を使用したサーバーサイド API 操作のデバッグと統合」をご参照ください。このドキュメントでは、OpenAPI プラットフォームで API 操作を呼び出す方法と、SDK およびそのサンプルコードを取得する方法について説明しています。
この API 操作は OpenAPI Explorer で実行してデバッグできます。また、この API 操作の SDK サンプルコード を生成することもできます。
画像フォーマットの要件
安定したモデル性能を確保するために、アップロードする画像は以下のすべての要件を満たす必要があります:
画像フォーマット: JPG、JPEG、または PNG。
画像サイズ: 推奨サイズは 50 KB から 100 KB です。最大サイズは 10 MB です。
説明パラメーターを base64 フォーマットで渡す場合、10 MB のデータ転送制限内に収まるように、元の画像サイズが 6 MB を超えないようにしてください。
画像解像度: 画像の高さと幅は 200 ピクセルから 8192 ピクセルの間である必要があります。推奨解像度は 480 × 640 ピクセル (高さ × 幅) です。
画像品質に関する推奨事項:
ID カード画像の四隅がすべて写っている必要があります。ドキュメントを持つ際に隠れてしまうと、検出に影響する可能性があるため避けてください。
ID カード画像のコンテンツは、鮮明で、遮られておらず、過度に露出した部分がないようにしてください。ID カード画像は、傾いていたり反転していたりしてはいけません。
ID カード画像は、画像全体の 60% 以上を占めるようにしてください。カードのエリアが小さいと、認識精度が低下します。
実際のドキュメントの写真を推奨します。
リクエストパラメーター
以下の 2 つのパラメーターのいずれかを使用して画像を提供できます:
IdOcrPictureBase64
IdOcrPictureUrl
名前 | タイプ | 必須 | 説明 | 例 |
ProductCode | String | はい | 使用するプロダクトソリューション。値を ID_OCR_MAX に設定します。 | ID_OCR_MAX |
SceneCode | String | いいえ | カスタムの認証シナリオ ID。この ID を使用して、コンソールで関連レコードをクエリできます。 英字、数字、アンダースコアの組み合わせで、最大 10 文字までです。 | 1234567890 |
MerchantBizId | String | はい | カスタムの一意のビジネス ID。後で問題を特定し、トラブルシューティングするために使用します。 英字と数字の組み合わせで、最大 32 文字までです。ID が一意であることを確認してください。 | e0c34a77f5ac40a5aa5e6ed20c35**** |
MerchantUserId | String | いいえ | 特定のユーザーに対するカスタムのユーザー ID またはその他の識別子 (携帯電話番号やメールアドレスなど)。 このフィールドの値は、事前にハッシュ化などで非識別化してください。 | 123456789 |
IdOcrPictureBase64 | String | いいえ | 身分証明書の Base64 エンコードされた画像。 IdOcrPictureBase64 を使用して身分証明書画像を渡す場合は、画像サイズを確認してください。大きすぎる画像を渡さないでください。 | base64 |
IdOcrPictureUrl | String | いいえ | 身分証明書画像の URL。URL は、パブリックネットワーク経由でアクセス可能な HTTP または HTTPS リンクである必要があります。 | https://***.jpg |
OcrModel | String | いいえ | 光学文字認識 (OCR) の認識モード: 説明 モード 1 と 2 は、ドキュメント品質検査またはなりすまし防止検出をサポートしていません。詳細については、「認識モードの違い」をご参照ください。
| 0 |
DocType | String | いいえ | 説明
| GLB03001 |
DocPage | String | いいえ | 認識するページ。
重要 モデルによって検出されたページが指定されたページと一致しない場合、Subcode 213 が返されます。 | 01 |
IdSpoof | String | いいえ | ドキュメントなりすまし防止機能を有効にするかどうかを指定します:
| F |
IdThreshold | String | いいえ | OCR 品質検査のカスタムしきい値モード:
| 3 |
OcrValueStandard | String | いいえ | 追加の OCR フィールドを標準化フォーマットで返すかどうかを指定します:
説明 サポートされているドキュメントタイプと標準化フィールドについては、「フィールドの標準化」をご参照ください。 | 0 |
Authorize | String | いいえ | ドキュメントのなりすまし防止能力を強化するために、権威あるデータソースを検証に使用するかどうかを指定します。
説明
| T |
認識モードの違い
OCR 認識モード | 入力の違い | 出力の違い | 推奨シナリオ |
0: 指定ドキュメント認識モード |
| このモードは、ドキュメントページから詳細なフィールドを出力します。詳細については、「ドキュメント OCR フィールド」をご参照ください。 | ID Verification のオンライン受付シナリオに推奨されます。このモードは、ドキュメントタイプがビジネスで許可されているかどうかを自動的に検証し、ドキュメントの顔写真のある面から詳細なフィールドを出力します。 |
1: 自動ドキュメント分類モード 重要 この認識モードは、インドネシアリージョンではサポートされていません。 |
| このモードは、検出されたドキュメントタイプコードのみを出力します。詳細については、「グローバル ID 証明書コード」をご参照ください。 | オフライン業務分析シナリオに推奨されます。このモードを使用して、過去の身分証明書画像のクラスタリングとクレンジングを行うことができます。 |
2: 自動ドキュメント分類および汎用認識モード 重要 この認識モードは、インドネシアリージョンではサポートされていません。 |
| このモードは、ドキュメントタイプとドキュメントの顔写真のある面から主要な標準化フィールドを出力します。詳細については、「汎用認識フィールドの表」をご参照ください。 説明 このモードは、異なるドキュメントタイプ間で共通のフィールドのみの出力をサポートします。 | 手動レビューの補助が必要なオフラインシナリオに推奨されます。このモードは、ドキュメントタイプと主要なフィールドを認識して、レビュー効率を向上させます。 |
フィールドの標準化
グローバルな身分証明書の多様性に対応するため、ID Verification はフィールド標準化機能を提供します。この機能は、以下の主要なドキュメントフィールドの標準化された出力フォーマットをサポートします。
サポートされているドキュメントタイプ
現在、韓国の以下の 3 種類の証明書のみがサポートされています。需要に応じて、追加の証明書タイプのサポートが追加されます。
韓国 | KOR01001 | 01 | |
KOR02001 | 01 | ||
KOR03001 | 01 |
サポートされている標準化フィールド
フィールド | タイプ | 説明 |
surname_s | String | ラテン文字の姓。 |
given_name_s | String | ラテン文字の名。 |
sex_s | String | 性別、F または M。 |
date_of_birth_s | String | yyyy-mm-dd 形式の生年月日。 |
date_of_expiry_s | String | yyyy-mm-dd 形式のドキュメントの有効期限。 |
レスポンスパラメーター
名前 | タイプ | 説明 | 例 | |
HTTP ステータスコード | Integer | HTTP ステータスコード。 | 200 | |
HTTP ボディ | RequestId | String | リクエスト ID。 | 130A2C10-B9EE-4D84-88E3-5384F******** |
Result.TransactionId | String | 認証プロセス全体の一意の ID。 | hksb7ba1b28130d24e015d694******** | |
Code | String | Success | ||
Message | String | 返された Code の詳細な説明。 | success | |
Result.Passed | String | 認識が完了したかどうかを示します。 | Y | |
Result.SubCode | String | 200 | ||
Result.ExtIdInfo | String |
|
| |
ExtIdInfo
名前 | タイプ | 説明 | 例 |
ocrIdInfo | String | 身分証明書の OCR フィールド情報。 説明 身分証明書の OCR プロセスが失敗した場合、このフィールドは空になります。 | |
spoofInfo | String | 証明書のなりすまし防止検出の結果。リスク結果とリスクタイプが含まれます。 説明 証明書検出は、Initialize 操作で IdSpoof を Y に設定した場合にのみ有効になります。 それ以外の場合、spoofResult はデフォルトで N を返し、spoofType は空になります。
| |
ocrDocType | String | 説明 このフィールドは、OcrModel が 1 または 2 に設定されている場合にのみ返されます。 | CHN01 |
ocrStandardData | String | 身分証明書の標準化された OCR フィールド情報。 説明 このフィールドは、ドキュメントタイプがサポートされており、 | |
リターンコード
HTTP ステータスコード | Code | Message |
200 | Success | リクエストは成功しました。 |
400 | MissingParameter | パラメーターは空にできません。 |
InvalidParameter | 無効なパラメーターです。 | |
401 | UnqualifiedPhoto | アップロードされた画像が読み取れないか、画像の解像度が要件を満たしていません。画像を交換することを推奨します。 写真が鮮明で、露出が正常で、遮蔽物がなく完全で、角度に大きなずれがないことを確認してください。 |
DataDuplication | Base64 エンコードされた画像と URL 画像アドレスの両方が提供されています。これらのパラメーターのいずれか 1 つのみを選択してください。 | |
ToolargeImage | 画像サイズが大きすぎます。画像を圧縮するか、アップロード方法を変更することを推奨します。 | |
DownloadTimeout | URL 画像のダウンロードがタイムアウトしました。 | |
403 | Forbidden.RAMUserAccessDenied | RAM ユーザーに AliyunAntCloudAuthFullAccess 権限を付与する必要があります。詳細については、「RAM ユーザーへのサービスアクセス権限の付与」をご参照ください。 |
Forbidden.AccountAccessDenied | ID Verification を有効にし、アカウントに支払い遅延がないことを確認してください。 | |
Throttling.Api | 速度制限により API リクエストがブロックされました。 | |
500 | InternalError | 内部システムエラー。トラブルシューティングのためにエンジニアにフィードバックを提供してください。 |
ResultObject.SubCode エラーコード
Subcode は、異なるプロダクトソリューションまたは統合方法に基づいて返されます。詳細については、次の表をご参照ください。
適用可能なソリューション | エラーコード | 認証レコードは課金対象か | 説明と推奨される理由 |
全般 | 200 | はい | 認証に合格しました。 |
| 211 | はい | 証明書画像の品質または解像度が要件を満たしていないか、画像自体が不完全です。証明書の顔写真のある面の写真が鮮明で、露出が正常で、遮蔽物がなく完全で、角度に大きなずれがないことを確認してください。 |
| 212 | はい | 証明書の偽造防止検出でリスクが示されました。再撮影、改ざん、コピーなどの高リスクな操作が行われた可能性があります。 |
| 213 | はい | 指定された証明書タイプが検出されなかった (認識モード) か、証明書タイプを識別できなかった (分類モード)。 鮮明で完全な、角度が正常な証明書画像をアップロードすることを推奨します。 |