すべてのプロダクト
Search

このプロダクト

    ID Verification:初期化

    ドキュメントセンター

    ID Verification:初期化

    最終更新日:Jan 13, 2025

    このトピックでは、Initializeオペレーションを呼び出して検証リクエストを開始する方法について説明します。

    検証リクエストを開始する

    オペレーション名：Initialize。

    エンドポイント：cloudauth-intl.cn-hongkong.aliyuncs.com。

    リクエストメソッド：HTTPS POST。

    オペレーションの説明：検証プロセスを開始する前に、このオペレーションを呼び出して、検証プロセスに含まれるさまざまなオペレーションのトランザクションIDを取得する必要があります。

    QPS制限：APIの1秒あたりのクエリ数（QPS）に制限が課されます。詳細については、「ID Verification - KYCサーバー側 API の QPS 制限」をご参照ください。

    リクエストパラメーター

    パラメーター

    タイプ

    必須

    説明

    例

    ProductCode

    String

    はい

    使用するソリューション。値を FACE_LIVENESS に設定します。

    FACE_LIVENESS

    SceneCode

    String

    いいえ

    カスタム検証シナリオの ID。ID Verification コンソールで ID を入力して、関連レコードをクエリできます。英字、数字、アンダースコア(_)を含む10文字のカスタム値を指定できます。

    1234567890

    MerchantBizId

    String

    はい

    ビジネスの一意の識別子。トラブルシューティングに使用されます。 英字と数字を含む 32 文字の値を指定できます。値が一意であることを確認してください。

    説明

    ID Verification は、値の一意性をチェックしません。追跡のために、一意の値を指定することをお勧めします。

    e0c34a77f5ac40a5aa5e6ed20c35****

    MetaInfo

    String

    はい

    環境パラメーター。これは、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 (既定値): セキュアモード。これは厳格なモードです。

      説明

      セキュアモードでは、ID Verification SDK に追加されたフェイスガードモジュールを使用して、デバイス情報に基づいて顔情報を収集するために使用されるデバイスのセキュリティを確認できます。これにより、インジェクション攻撃を阻止できます。このモードを選択することをお勧めします。

    02

    Model

    String

    いいえ

    実行するライブネス検出のタイプ。有効な値：

    • LIVENESS（デフォルト）：まばたきベースの検出。

    • PHOTINUS_LIVENESS（推奨）：まばたきベースと色ベースのライブネス検出。

    • PHOTINUS_FAR_NEAR_LIVENESS：まばたきベース、近距離および遠距離ベース、さらに色ベースのライブネス検出。

    説明

    • 統合可能な SDK バージョンについては、[SDK リリースノート]をご参照ください。

    • まばたきベースと色ベースのライブネス検出は、PC ではサポートされていません。

    PHOTINUS_LIVENESS

    DocVideo

    String

    いいえ

    証拠ビデオを保存するかどうかを指定します。有効な値：

    • N（デフォルト）：ビデオは保存されません。

    • Y：検証プロセス中に、1～2秒続く顔検証プロセスのビデオが収集され、クエリ操作から返されます。

    説明

    • ビデオファイルのサイズが大きいため、ネットワークが不安定な場合、システムはビデオファイルを破棄します。これにより、検証に必要な画像の安定した転送が保証されます。

    • PC からはビデオを返すことができません。

    N

    CallbackUrl

    String

    いいえ

    検証結果を通知するために使用されるコールバック URL。デフォルトでは、GET メソッドを使用してコールバックリクエストが送信されます。コールバック URL は https で始まる必要があります。検証が完了すると、システムはコールバック URL にコールバックリクエストを送信し、次のフィールドをコールバックリクエストに自動的に追加します。

    • transactionId

    • passed

    • code

    • subcode

    警告

    コールバック URL が使用される前に、システムは URL にアクセスできるかどうかを確認します。インターネット経由で URL にアクセスできない場合、ステータスコード 400 が返されます。

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

    CallbackToken

    String

    いいえ

    重複防止および改ざん防止検証に使用されるセキュリティトークン。カスタム値を指定できます。

    このパラメーターを設定すると、コールバック URL に送信されるコールバックリクエストに CallbackToken フィールドが含まれます。

    NMjvQanQgplBSaEI0sL86WnQplB

    AppQualityCheck

    String

    いいえ

    厳格な顔品質検出機能を有効にするかどうかを指定します。有効な値：

    • Y（デフォルト）

    • N

    重要

    • この機能を有効にするには、顔品質検出モジュールをクライアント SDK と統合する必要があります。顔品質検出モジュールがクライアント SDK と統合されていない場合、この機能は自動的に無効になります。

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

    N

    レスポンスパラメーター

    パラメーター

    タイプ

    説明

    例

    HTTP ステータスコード

    Integer

    HTTP ステータスコード。

    200

    HTTP Body

    RequestId

    String

    リクエスト ID。

    130A2C10-B9EE-4D84-88E3-5384FF039795

    Code

    String

    リクエストに対して返されるコード。詳細については、このトピックの「コードとメッセージの説明」セクションをご参照ください。

    Success

    Message

    String

    リクエストに対して返されるメッセージ。

    success

    Result.TransactionId

    String

    検証プロセスの一意の識別子。このパラメーターは課金に使用されます。このパラメーターは、CheckResult オペレーションの呼び出しにも使用されます。

    説明

    リクエストで無効なパラメーターに関するエラーなどのエラーが発生した場合、Result.TransactionId は返されません。

    hksb7ba1b28130d24e015d694361bee4

    コードとメッセージの説明

    HTTP ステータスコード

    コード

    メッセージの説明

    200

    Success

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

    400

    MissingParameter

    必須パラメーターが空です。

    400

    InvalidParameter

    パラメーターが無効な値に設定されています。

    403

    Forbidden.RAMUserAccessDenied

    AliyunAntCloudAuthFullAccess ポリシーがResource Access Management (RAM) ユーザーにアタッチされていません。詳細については、「RAM ユーザーにID Verification - KYCへのアクセスを承認する」をご参照ください。

    403

    Forbidden.AccountAccessDenied

    アカウントの支払いが延滞しています。アカウントへの入金を行い、もう一度お試しください。

    403

    Throttling.Api

    API スロットリングがトリガーされています。

    500

    InternalError

    内部エラーが発生しました。エラーのトラブルシューティングを行うには、エンジニアにフィードバックを送信することをお勧めします。