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

ID Verification:初期化

最終更新日:Feb 01, 2026

このトピックでは、Initialize API 操作を呼び出して、証明書の光学文字認識 (OCR) のリクエストを開始する方法について説明します。

認証リクエストの開始

  • API 操作名: Initialize

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

  • 説明: 各証明書 OCR プロセスを開始する前に、この API 操作を呼び出して transactionId を取得します。transactionId は、認証リクエスト内のすべての API 操作をリンクします。

  • この API 操作には専用の QPS 制限があります。詳細については、「ID Verification サーバーサイド API 操作の QPS 制限」をご参照ください。

  • サービスエンドポイント:

    説明
    • 内部ネットワークアクセスの利点: 内部ネットワークは、同一リージョン内の Alibaba Cloud プロダクト間のプライベート通信ネットワークです。ご利用のビジネスサーバーが対応する Alibaba Cloud リージョンにデプロイされている場合、内部の同一リージョンエンドポイントを使用して ID Verification サービスにアクセスできます。これにより、より安全で安定した通信が提供されます。

    • 中国以外からのアクセスの最適化に関する提案: 中国以外のネットワーク環境は複雑になる可能性があります。統合ソリューションを最適化し、ネットワーク遅延を削減し、リクエストの失敗を最小限に抑えるには、「サーバーサイドのネットワーク遅延分析と最適化」をご参照ください。

    中国 (香港)

    • パブリックネットワーク: cloudauth-intl.cn-hongkong.aliyuncs.com

    • 内部ネットワーク: cloudauth-intl-vpc.cn-hongkong.aliyuncs.com

オンラインでのデバッグと統合

説明

API 操作をデバッグおよび統合する前に、「OpenAPI Explorer を使用したサーバーサイド API 操作のデバッグと統合」で、API 操作の呼び出し方法、および OpenAPI Explorer での SDK とサンプルコードの取得方法に関する情報をご参照ください。

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

リクエストパラメーター

名前

タイプ

必須

説明

ProductCode

String

はい

使用するプロダクトプラン。値を ID_OCR に設定します。

ID_OCR

SceneCode

String

いいえ

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

1234567890

MerchantBizId

String

はい

トラブルシューティング用の一意のカスタムビジネス ID。ID には、最大 32 文字の英字と数字を含めることができます。一意性を確保してください。

説明

Alibaba Cloud サーバーは、この値の一意性をチェックしません。追跡しやすくするために、値が一意であることを確認してください。

e0c34a77f5ac40a5aa5e6ed20c35****

MetaInfo

String

はい

MetaInfo 環境パラメーター。このパラメーターは、クライアント 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

はい

カスタムユーザー ID または特定のユーザーの別の識別子 (携帯電話番号やメールアドレスなど)。ハッシュ化などにより、この値を事前に非識別化することを強く推奨します。

123456789

IdSpoof

String

いいえ

証明書のなりすまし防止検出を有効にするかどうかを指定します:

  • Y:有効

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

Y

DocType

String

はい

証明書タイプ。8 桁の数字が一意の識別子として機能します。詳細については、次の表をご参照ください。

01000000

IdThreshold

String

いいえ

カスタム OCR 品質検出のしきい値モード:

  • 0:標準モード

  • 1:厳格モード

  • 2:緩和モード

  • 3:品質検出を無効化 (デフォルト)

0

CallbackUrl

String

いいえ

検証結果通知用の Webhook アドレス。コールバックリクエストメソッドはデフォルトで GET です。Webhook アドレスは https で始まる必要があります。検証が完了すると、プラットフォームはこのアドレスにコールバックを送信し、次のフィールドを自動的に追加します:

  • transactionId

  • passed

  • subcode

警告
  • システムは、API 操作が呼び出される前に、このアドレスがアクセス可能かどうかをチェックします。アドレスがパブリックネットワーク経由でアクセスできない場合、400 エラーが返されます。

  • コールバックは検証完了直後に実行されますが、ネットワークの問題により遅延する場合があります。まずクライアントで検証完了通知を受信し、次にクエリ API 操作を呼び出して検証詳細を取得することを推奨します。

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

CallbackToken

String

いいえ

生成するセキュリティトークン。リプレイ防止および改ざん防止チェックに使用されます。

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

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

リターンコード

Success

Message

String

レスポンスコードの詳細な説明。

success

Result.TransactionId

String

検証フロー全体の一意の識別子。このフィールドは、課金統計および CheckResult API 操作リクエストの開始に使用されます。

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

  • TransactionId を現在のビジネスフローのビジネス ID にアタッチし、サーバーサイドに保存します。CheckResult を呼び出すときは、サーバーサイドのストレージからこの検証 ID を取得して、結果クエリを開始します。

  • TransactionId または TransactionUrl を取得した後、30 分以内に検証を完了する必要があります。この期間を過ぎると、ID または URL は自動的に無効になり、検証に使用できなくなります。

hksb7ba1b28130d24e015d6********

Result.Protocol

String

hksb7ba1b28130d24e015d*********

リターンコード

HTTP ステータスコード

コード

説明

200

Success

リクエストは成功しました。

400

MissingParameter

パラメーターを空にすることはできません。

InvalidParameter

無効なパラメーターです。

401

Forbidden.ExceptionRepeatedInvoke

繰り返された異常な呼び出しの数が制限を超えました。

403

Forbidden.RAMUserAccessDenied

RAM ユーザーに AliyunAntCloudAuthFullAccess 権限を付与する必要があります。詳細については、「RAM ユーザーへのサービスへのアクセス権限の付与」をご参照ください。

Forbidden.AccountAccessDenied

ID Verification を有効にし、アカウントに支払い遅延がないことを確認してください

Throttling.Api

API リクエストはスロットリングによりブロックされています。

500

InternalError

内部システムエラー。トラブルシューティングのため、エンジニアにお問い合わせください。

503

ServiceUnavailable

サービスは利用できません。トラブルシューティングのため、エンジニアにお問い合わせください。