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

ID Verification:Initialize

最終更新日:Feb 01, 2026

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

認証リクエストの開始

  • API 操作: Initialize

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

  • 説明: 認証フローを開始する前に、この操作を呼び出して transactionId を取得します。この ID は、認証リクエストのすべての 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 とサンプルコードを取得する方法についての情報を確認してください。

この操作は OpenAPI Explorer で直接呼び出してテストし、この操作の SDK サンプルコードを生成できます。

リクエストパラメーター

名前

必須

説明

ProductCode

String

はい

使用するプロダクトソリューション。有効な値は FACE_LIVENESS のみです。

FACE_LIVENESS

SceneCode

String

いいえ

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

1234567890

MerchantBizId

String

はい

カスタムの一意のビジネス識別子。問題の追跡やトラブルシューティングに使用できます。識別子は最大 32 文字で、英字と数字を使用できます。識別子が一意であることを確認してください。

説明

Alibaba Cloud サーバーは、この値の一意性をチェックしません。追跡を改善するために、このフィールドの一意性を確保することを強く推奨します。

e0c34a77f5ac40a5aa5e6ed20c35****

MetaInfo

String

はい

MetaInfo 環境パラメーター。実際の環境では、JS ファイルの getMetaInfo() 関数を呼び出してこのパラメーターを取得する必要があります。詳細については、「Android 統合」をご参照ください。

説明

戻り値を変更しないでください。直接渡してください。

{
  "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

SecurityLevel

String

いいえ

検証フローの異なるセキュリティレベルを表すモード。有効な値:

  • 01標準モード。このモードは、デバイス情報の収集に制限がある低脅威のシナリオにのみ適用されます

  • 02安全モード。比較的厳格なモード (デフォルト)

    説明
    • 安全モードでは、SDK の新しい Device Guard モジュールを使用して、デバイス情報に基づいて顔スキャン環境のセキュリティを識別します。これにより、インジェクション攻撃を阻止する能力が効果的に向上します。このモードを有効にしてください。

    • 開発およびテスト中、テストデバイスの環境特性により、Device Guard がそれを脅威と評価し、検証失敗 (Subcode 206) をトリガーする可能性があります。テスト効率を向上させるために、テスト段階ではモードを「01 標準モード」に設定してください。本番稼働時には、「02 安全モード」に切り替えて検証セキュリティを強化してください。

02

Model

String

いいえ

実行する生体検知のタイプ:

  • LIVENESS: 瞬き生体検知 (デフォルト)。

  • PHOTINUS_LIVENESS: 瞬き生体検知と色彩生体検知 (PC ではサポートされていません)。

説明

サポートされている SDK のバージョンについては、「SDK リリースノート」をご参照ください。

PHOTINUS_LIVENESS

DocVideo

String

いいえ

検証ビデオを保存するかどうかを指定します。

  • N: いいえ (デフォルト)。

  • Y: 検証中にユーザーの顔スキャンプロセスのビデオ (1〜2 秒のビデオファイル) が収集され、クエリ API 操作を通じて返されます。

説明

ビデオファイルはサイズが大きいため、ネットワークが不安定な場合、システムは重要な検証画像の送信を優先するためにビデオファイルを破棄することがあります。

N

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

いいえ

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

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

NMjvQanQgplBSaEI0sL86WnQplB

AppQualityCheck

String

いいえ

厳格な顔品質チェックを有効にするかどうかを指定します:

  • Y: はい。(デフォルト)

  • N: いいえ。

重要
  • この構成には、クライアントサイド SDK からのサポートが必要です。この機能を有効にしても、クライアントサイド SDK に顔品質検出モジュールが統合されていない場合、この構成は無効として扱われます。

  • クライアントサイド SDK はバージョン 1.2.5 以降である必要があります。

N

戻りデータ

名前

説明

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 ステータスコード

Code

説明

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

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