DocOcrV2 API を統合して、ID ドキュメント画像から情報を抽出し、サーバー側でなりすまし脅威を検出します。
API 情報
API オペレーション名: DocOcrV2
リクエストメソッド: HTTPS POST
説明: OCR を使用して 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 を取得する方法を理解してください。
この API オペレーションは OpenAPI Explorer でデバッグし、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。最大 10 文字で、英字、数字、アンダースコア (_) をサポートします。 | 1234567890 |
MerchantBizId | String | はい | 追跡とトラブルシューティングのためのユニークなビジネス ID。最大 32 文字で、英字と数字をサポートします。 説明 Alibaba Cloud は一意性を強制しません。効果的な追跡のために、この値が一意であることを確認してください。 | e0c34a77f5ac40a5aa5e6ed20c35**** |
MerchantUserId | String | はい | 電話番号やメールアドレスなどのユーザー識別子。送信前にこの値をハッシュ化することを推奨します。 | 123456789 |
IdOcrPictureBase64 | String | いいえ 説明 3つのアップロード方法のいずれか1つを選択できます。 | ID ドキュメントの顔写真面の base64 エンコードされた画像。画像がサイズ制限を超えないようにしてください。 | base64 |
IdOcrPictureUrl | String | ID ドキュメントの顔写真面のパブリックにアクセス可能な HTTP または HTTPS の URL。 | https://*** | |
IdOcrPictureFile | InputStream | ID ドキュメントの画像ファイルストリーム。 | 具体的な統合方法については、「Advance インターフェイスでのファイルアップロード」をご参照ください。 | |
DocType | String | はい | ID ドキュメントタイプ、8 桁の識別子。「ドキュメントタイプ一覧」をご参照ください。 | F |
Ocr | String | はい | OCR を有効にしてドキュメント情報を自動的に抽出するかどうか。
| T |
IdFaceQuality | String | いいえ | ID ドキュメントの顔品質スコアを返すかどうか。デフォルトでは無効です。 説明 このパラメーターは、ID ドキュメントの顔写真面にのみ有効です。
| F |
Spoof | String | いいえ | ID ドキュメントのなりすまし防止検出を有効にするかどうか。デフォルトでは無効です。 説明 このパラメーターは、ID ドキュメントの顔写真面にのみ有効です。
| F |
IdThreshold | String | いいえ | OCR 品質チェックのモードを設定します。有効な値は次のとおりです:
| 3 |
CardSide | String | いいえ | 認識する ID ドキュメントの面。デフォルトは顔写真面です。
重要 このパラメーターは、中華人民共和国の居民身分証にのみ適用されます。 | OCR_ID_NATIONAL_EMBLEM |
ドキュメントタイプ一覧
DocType | 対応ドキュメント |
01000000 | グローバルパスポート |
00000006 | 香港 ID カード (2003年版) |
00000008 | 香港 ID カード (2018年版) |
00000007 | 港澳通行証 |
00000009 | 港澳居民往来内地通行証 |
000000011 | マカオ ID カード |
000000012 | 台湾居民来往大陸通行証 |
00000001 | 中国本土の第2世代居民身分証 |
レスポンスパラメーター
名前 | タイプ | 説明 | 例 | |
HTTP ステータスコード | Integer | HTTP ステータスコード。 | 200 | |
HTTP ボディ | 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 | 認証結果の説明。詳細については、「ResultObject.SubCode エラーコード」をご参照ください。 | 200 | |
Result.ExtIdInfo | String | JSON フォーマットの ID ドキュメント認識結果。右の例と「ExtIdInfo」をご参照ください。 | | |
ExtIdInfo
名前 | タイプ | 説明 | 例 |
ocrIdInfo | String | ID ドキュメントの OCR フィールド。「OCR 認識レスポンスフィールド」をご参照ください。 説明 ID ドキュメントの OCR プロセスが失敗した場合、このフィールドは空になります。 | |
idFaceQualityScore | Double | ID ドキュメント画像内の顔品質スコア。範囲: 0~100。 | 99.95 |
spoofInfo | String | なりすまし検出の結果。リスク判定とリスクタイプを含みます: 説明 カードなりすまし検出は、Initialize リクエストで IdSpoof = Y の場合にのみ有効になります。 それ以外の場合、spoofResult はデフォルトで N になり、spoofType は空になります。
| |
ResultObject.SubCode エラーコード
Subcode は、異なるプロダクトソリューションや統合方法に基づいて返されます。詳細については、次の表をご参照ください。
適用ソリューション | エラーコード | 認証レコードは課金対象か | 説明と推奨される理由 |
一般 | 200 | はい | 認証成功。 |
| 211 | はい | 証明書画像の品質または解像度が要件を満たしていないか、画像自体が不完全です。証明書の顔写真面の写真が鮮明で、露出が正常で、遮蔽がなく完全であり、角度のずれが著しくないことを確認してください。 |
| 212 | はい | 証明書の偽造防止検出でリスクが示されました。再撮影、改ざん、コピーなどの高リスク操作の可能性があります。 |
| 213 | はい | 指定された証明書タイプが検出されなかった (認識モード) か、証明書タイプを識別できませんでした (分類モード)。 鮮明で完全な、角度が正常な証明書画像をアップロードすることを推奨します。 |
OCR レスポンスフィールド
香港永久性居民身分証
2003年版と2018年版の両方のスマート ID カードがサポートされています。
パラメーター | タイプ | 説明 |
name | String | 氏名 |
englishName | String | 英語名 |
nameCode | String | 中国商用コード |
sex | String | 性別。有効な値:
|
birthDate | String | 生年月日 |
idNumber | String | ID カード番号 |
currentIssueDate | String | 登録日 |
firstIssueDate | String | 初回登録年月 |
isPermanent | String | これが永久性居民身分証であるかどうかを指定します。有効な値:
|
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 | 発行機関 |
台湾居民来往大陸通行証
パラメーター | タイプ | 説明 |
name | String | 氏名 |
englishName | String | 氏名 (ピンイン) |
sex | String | 性別 |
birthDate | String | 生年月日 |
idNumber | String | ドキュメント番号 |
issueDate | String | 発行日 |
expiryDate | String | 有効期限 |
originOfIssue | String | 発行機関 |
placeOfIssue | String | 発行地 |
eパスポート
このドキュメントタイプは、ICAO 準拠の eパスポートの機械読み取り領域 (MRZ) を読み取ります。標準的なフィールドセットを抽出することで、フォーマットが異なることが多い各国のパスポート間での互換性を確保します。
パラメーター | タイプ | 説明 |
surname | String | MRZ からのラテン文字の姓。 |
givenname | String | MRZ からのラテン文字の名。 |
sex | String | 性別。 |
birthDate | String | 生年月日。 |
passportNo | String | パスポート番号 |
nationality | String | 国籍。3文字の国コードで表されます。 |
expiryDate | String | 有効期限。 |
countryCode | String | 発行機関の国コード。 (3文字の国コード) |
マカオ居民身分証
パラメーター | タイプ | 説明 |
surnameCN | String | 姓 (中国語) |
givennameCN | String | 名 (中国語) |
surname | String | 姓 (英語) |
givenname | String | 名 (英語) |
sex | String | 性別 |
birthDate | String | 生年月日 |
idNumber | String | ドキュメント番号 |
expiryDate | String | 有効期限 |
placeOfBirth | String | 出生地コード。例: "***AZ"。 |
中国本土 ID カード
パラメーター | タイプ | 説明 |
name | String | 氏名 |
sex | String | 性別 |
ethnicity | String | 民族 |
birthDate | String | 生年月日 |
idNumber | String | ID 番号 |
address | String | 住所 |
province | String | 省 説明 予約フィールド。デフォルトでは空で返されます。 |
city | String | 市 説明 予約フィールド。デフォルトでは空で返されます。 |
originOfIssue | String | 発行機関 |
issueDate | String | 発行日 |
expiryDate | String | 有効期限 |