すべてのプロダクト
Search
ドキュメントセンター

ID Verification:InitializeV2

最終更新日:Jul 01, 2026

ドキュメント OCR セッションを開始し、後続のすべての API 呼び出しをリンクする transactionId を返します。

認証リクエストの開始

  • API オペレーション: InitializeV2

  • リクエストメソッド: HTTPS POST

  • 説明: 各ドキュメント OCR プロセスの前にこのオペレーションを呼び出して、リクエスト内のすべての操作をリンクする transactionId を取得します。

  • 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 の使用」ガイドを読み、OpenAPI プラットフォームで API を呼び出す方法と SDK を取得する方法を理解してください。

この API オペレーションは OpenAPI Explorer で直接実行してデバッグし、 SDK コードサンプル を生成できます。

リクエストパラメーター

名前

タイプ

必須

説明

ProductCode

String

はい

プロダクトコード。ID_OCR に設定します。

ID_OCR

SceneCode

String

いいえ

コンソールで関連レコードをクエリするためのカスタム認証シナリオ ID。最大 10 文字の英字、数字、アンダースコア (_) を使用できます。

1234567890

MerchantBizId

String

はい

トラブルシューティング用の一意のビジネス ID。最大 32 文字の英字と数字を使用できます。

説明

一意性はサーバー側では強制されません。正確な追跡のために、各値が一意であることを確認してください。

e0c34a77f5ac40a5aa5e6ed20c35****

MetaInfo

String

はい

クライアント SDK から取得した環境パラメーター。「Android SDK 統合」をご参照ください。

説明

戻り値を変更しないでください。そのまま渡してください。

{"zimVer":"3.0.0","appVersion": "1","bioMetaInfo": "4.1.0:1150****,0","appName": "com.aliyun.antcloudauth","deviceType": "ios","osVersion": "iOS 10.3.2","apdidToken": "","deviceModel": "iPhone9,1"}

MerchantUserId

String

はい

電話番号やメールアドレスなどのユーザー識別子。ハッシュ化するなど、事前にこの値を非識別化することを強く推奨します。

123456789

IdSpoof

String

いいえ

ドキュメントのなりすまし防止検出を有効にするかどうか:

  • Y:有効

  • N:無効 (デフォルト)

Y

DocType

String

はい

ドキュメントタイプ。ドキュメントを識別する 8 桁のコード。サポートされている値については、次の表をご参照ください。

01000000

IdThreshold

String

いいえ

OCR 品質チェックのモードを設定します。有効な値は次のとおりです:

  • 0:標準モード

  • 1:厳格モード

  • 2:緩和モード

  • 3 (デフォルト):品質チェックを無効にします。

0

CallbackUrl

String

いいえ

認証結果を受信するためのコールバック URL。コールバックリクエストはデフォルトで GET メソッドを使用し、URL は https で始まる必要があります。認証が完了すると、プラットフォームはこの URL を呼び出し、次のパラメーターを自動的に追加します:

  • transactionId

  • passed

  • subcode

警告
  • サービスは、API 呼び出しを処理する前に、この URL のアクセシビリティを検証します。指定された URL がパブリックネットワークからアクセスできない場合、サービスは 400 エラーを返します。

  • コールバックは認証プロセスの完了直後にトリガーされますが、ネットワークの状態によって遅延する場合があります。まずクライアントで完了通知を処理し、その後クエリ API を呼び出して詳細な認証結果を取得することを推奨します。

https://www.aliyun.com?callbackToken=100000****&transactionId=shaxxxx&passed=Y&subCode=200

CallbackToken

String

いいえ

リプレイ防止および改ざん防止チェックのために生成するセキュリティトークン。

このパラメーターを設定すると、CallbackToken フィールドが CallbackUrl コールバックに含まれます。

NMjvQanQgplBSaEI0sL86WnQplB

DocPageConfig

String

いいえ

JSON 文字列配列:

OCR_ID_BACK:裏面を収集します。

説明

現在、中国本土の ID カードのみがサポートされています。

OCR_ID_BACK

ShowGuidePage

String

いいえ

ガイドページを表示するかどうか:

  • 1 (デフォルト):表示

  • 0:非表示

1

DocScanMode

String

いいえ

OCR ドキュメントスキャンモード:

  • shoot (デフォルト):写真撮影

  • scan:スキャン

  • auto:写真撮影とスキャンの自動切り替え

shoot

ドキュメントタイプ

DocType

ドキュメント

01000000

グローバルパスポート

00000001

中国本土の第 2 世代住民 ID カード

00000006

香港 ID カード (2003 年版)

00000008

香港 ID カード (2018 年版)

00000007

港澳通行証

00000009

港澳居民往来内地通行証

000000011

マカオ (中国) ID カード

000000012

台湾居民来往大陸通行証

応答パラメーター

名前

タイプ

説明

HTTP ステータスコード

Integer

HTTP ステータスコード。

200

HTTP ボディ

RequestId

String

リクエスト ID。

130A2C10-B9EE-4D84-88E3-5384FF03****

Code

String

戻りコード:詳細については、「サーバー側の HTTP ステータスコード」をご参照ください。

Success

Message

String

応答コードの詳細な説明。

success

Result.TransactionId

String

認証プロセスの一意の識別子。このフィールドは、課金統計や CheckResult API の呼び出しに使用されます。

重要
  • リクエスト中に無効なパラメーターなどのエラーが発生した場合、TransactionId は返されません。

  • TransactionId をビジネスプロセス ID に関連付け、サーバー側に保存してください。CheckResult API を呼び出すときは、サーバー側のストレージからこの ID を取得して結果をクエリします。

  • TransactionId または TransactionUrl を取得してから 30 分以内に認証プロセスを完了する必要があります。この期間を過ぎると、ID は有効期限切れとなり、認証に使用できなくなります。

hksb7ba1b28130d24e015d6********

Result.Protocol

String

標準認証プロトコルのための暗号化された文字列。

このパラメーターをクライアント SDK に渡すことで、ネットワークインタラクションが減少し、動的なネットワーク切り替えがサポートされるため、ユーザーエクスペリエンスが向上します。

hksb7ba1b28130d24e015d*********