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

ID Verification:UniApp 連携

最終更新日:Jun 30, 2026

ID Verification は、UniApp プラットフォーム用のプラグインを提供します。このプラグインを使用すると、eKYC リモート本人確認機能を UniApp アプリケーションに追加できます。このトピックでは、UniApp 連携プロセスについて説明し、コード例を示します。

事前準備

一部の開発者は、Alibaba Cloud ID Verification のソフトウェア開発キット (SDK) をカプセル化して、サードパーティのプラグインを作成しています。これらのプラグインは、さまざまなプラットフォームで販売されています。これらの非公式なプラグインやサービスの使用から生じるいかなる問題についても、Alibaba Cloud は責任を負わず、法的責任も一切負いません。安定性とセキュリティを確保するため、Alibaba Cloud の公式 SDK を使用してください。

依存関係の設定

UniApp プラグインを連携するには、DCloud の公式ドキュメントをご参照いただくか、次の手順に従ってください。

  1. SDK リリースノートに移動して UniApp SDK をダウンロードし、プロジェクトの nativePlugins ディレクトリに解凍します。

  2. ローカルプラグインをインポートします。

    1. manifest.json ファイルで、[App ネイティブプラグイン設定] をクリックします。

    2. [App Native プラグイン設定] セクションで、[ローカルプラグインの選択] をクリックします。

    3. [ローカルプラグインの選択] ダイアログボックスで、パッケージ化するプラグインを選択します。

  3. カスタムデバッグベースを作成します。

    1. カスタムデバッグベースを作成するには、manifest.json ファイルで[実行] > [スマートフォンまたはエミュレーターで実行] > [カスタムデバッグベースの作成]を選択します。

    2. カスタムデバッグベースを設定するには、manifest.json ファイルで、[実行] > [電話またはエミュレーターで実行] > [カスタムデバッグベースの作成] > [Android/iOS アプリベースで実行]を選択します。

      説明

      リリースバージョンをパッケージ化するには、[公開] > [ネイティブアプリ - クラウドパッケージング]を選択します。

サービスの呼び出し

  1. initWithOptions メソッドを呼び出して SDK を初期化します。このメソッドは、options パラメーターを JSON オブジェクトとして受け入れます。

    options パラメーターは、デフォルトでは null で、オプションのデータ収集設定を指定します。

    重要
    • ID Verification クライアントには、デバイスヘルパーとして知られるセキュリティモジュールが組み込まれています。デバイスヘルパーは、現地のデータ収集コンプライアンス要件を満たすために、さまざまなデータ報告リージョンを提供します。ユーザーの属性に基づいて、CustomUrlCustomHost を設定して、異なる報告サイトを指定できます。

    • アプリケーションセッションのライフサイクルごとに指定できるデータ報告リージョンは 1 つだけです。サーバー側のクエリのリージョンは、報告リージョンと一致する必要があります。サポートされるリージョンはプロダクトによって異なります。詳細については、「サポートされるリージョン」をご参照ください。

    • 各リージョンの CustomUrl は以下の通りです:

      • 中国 (香港)https://cloudauth-device.cn-hongkong.aliyuncs.com

      • シンガポールhttps://cloudauth-device.ap-southeast-1.aliyuncs.com

      • インドネシア (ジャカルタ)https://cloudauth-device.ap-southeast-5.aliyuncs.com

      • 米国 (シリコンバレー)https://cloudauth-device.us-west-1.aliyuncs.com

      • ドイツ (フランクフルト)https://cloudauth-device.eu-central-1.aliyuncs.com

      • マレーシア (クアラルンプール)https://cloudauth-device.ap-southeast-3.aliyuncs.com

    パラメーター

    説明

    IPv6

    デバイス情報を報告するために IPv6 ドメイン名を使用するかどうかを示します:

    • 0 (デフォルト):いいえ (IPv4 ドメイン名を使用)

    • 1:はい (IPv6 ドメイン名を使用)

    "1"

    DataSwitch

    デバイス情報をいつ報告するかを制御します:

    • 0 (デフォルト):SDK の初期化時

    • 1:トークン取得時

    説明

    デフォルト設定を推奨します。

    "1"

    CustomUrl

    データ報告用のサーバードメイン名を設定します。

    各リージョンの CustomUrl」をご参照ください。

    CustomHost

    データ報告用のサーバーホストを設定します。

    "cloudauth-device.ap-southeast-1.aliyuncs.com"

    説明

    この例はシンガポールリージョン用です。他のリージョンのサーバーホストについては、「各リージョンの CustomUrl」をご参照ください。

  2. getMetaInfo 関数を呼び出して MetaInfo データを取得します。ID Verification サーバーを呼び出して検証リクエストを開始するときに、この値を渡します。

  3. 検証を開始するには、 startVerify 関数を呼び出して transactionId を渡します。 transactionId は、サーバーサイドの Initialize API を呼び出すことで取得できます。

  4. startVerify() インターフェイスを呼び出して、検証リクエストを開始します。

    startVerify() インターフェイスには、次のパラメーターがあります:

    • transactionId:必須パラメーター。

    • extParams:オプションの拡張パラメーター。

      拡張パラメーター ( extParams ) の設定方法については、ネイティブの Android および iOS SDK のドキュメントをご参照ください。

      Android

      キー

      説明

      例 (文字列型)

      IdentityParams.OcrResultButtonColor

      OCR 結果ページ下部にあるボタンの色です。

      #FF0000

      IdentityParams.RoundProgressColor

      顔スキャン中の円の色です。

      #FF0000

      IdentityParams.ShowBlbumIcon

      ドキュメント OCR 中に、アルバムアップロードのエントリを表示します:

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

      • 0:非表示

      1

      IdentityParams.ShowOcrResult

      ドキュメント OCR 中に、認識結果ページを表示します:

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

      • 0:非表示

      1

      IdentityParams.EditOcrResult

      ドキュメント OCR 中に、認識結果ページを編集可能にします:

      • 1 (デフォルト):編集可能

      • 0:編集不可

      1

      IdentityParams.MaxErrorTimes

      最大リトライ回数です。

      範囲は 3 から 10 に設定します。 デフォルトは 10 です。

      10

      IdentityParams.CardOcrTimeOutPeriod

      OCR 認識プロセスのタイムアウト時間です。

      範囲は 20 秒から 60 秒に設定します。 デフォルトは 20 秒です。

      20

      IdentityParams.FaceVerifyTimeOutPeriod

      ライブネス収集検出プロセスのタイムアウト時間です。

      範囲は 20 秒から 60 秒に設定します。 デフォルトは 20 秒です。

      20

      IdentityParams.OcrResultTimeOutPeriod

      OCR 認識結果ページの編集可能時間です。

      この設定はカスタマイズ可能です。 デフォルトでは制限はありません。

      60

      IdentityParams.SdkLanguage

      SDK の表示言語をカスタマイズできます。デフォルトでは、SDK はモバイルデバイスのシステム言語を使用します。

      説明

      サポートされている言語の一覧については、「Android および iOS SDK の言語のカスタマイズ」をご参照ください。

      zh-Hans

      IdentityParams.CloseButtonLayout

      閉じるボタンのレイアウト:

      • left (デフォルト):左側

      • right:右側

      left

      IdentityParams.WaterMark

      OCR 成功後のウォーターマークテキストです。

      テスト用ウォーターマークテキスト

      IdentityParams.Protocol

      SDK プロトコルです。

      説明

      サーバー側の 初期化 API を通じて プロトコル を取得します。拡張パラメーターで渡すことにより、SDK 内部の API インタラクションが減り、ネットワークエクスペリエンスが向上します。

      なし

      iOS

      Key

      Description

      Example (string)

      kIdentityParamKeyNextButtonColor

      OCR 認識結果ページの下部ボタンの色。

      #FF0000

      kIdentityParamKeyRoundProgressColor

      顔スキャン中の円形プログレスインジケーターの色。

      #FF0000

      kIdentityParamKeyOcrSelectPhoto

      ID OCR 認識ステップ中に、フォトアルバムからのアップロード導線を表示するかどうかを指定します:

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

      • 0:非表示

      1

      kIdentityParamKeyShowOcrResult

      ID OCR 認識ステップ後に、認識結果ページを表示するかどうかを指定します:

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

      • 0:非表示

      1

      kIdentityParamKeyEditOcrResult

      ID OCR 認識ステップ中に、認識結果ページを編集可能にするかどうかを指定します:

      • 1 (デフォルト):編集可能

      • 0:編集不可

      1

      kIdentityParamKeyMaxRetryCount

      最大リトライ回数です。有効な値:3 ~ 10。デフォルト値:10。

      10

      kIdentityParamKeyCardOcrTimeOutPeriod

      OCR 認識ステップのタイムアウト時間です。有効な値:20 ~ 60 秒。デフォルト値:20 秒。

      20

      kIdentityParamKeyFaceVerifyTimeOutPeriod

      生体検知ステップのタイムアウト時間です。有効な値:20 ~ 60 秒。デフォルト値:20 秒。

      20

      kIdentityParamKeyCardOcrEditTimeOutPeriod

      OCR 認識結果ページが編集可能な状態を維持する時間 (秒) です。有効な値:60 ~ 180。デフォルトでは無制限です。

      180

      kIdentityParamKeyLanguage

      SDK の言語を設定します。デフォルトでは、SDK は OS の言語を使用します。

      説明

      サポートされている言語の一覧については、「Android および iOS SDK の言語のカスタマイズ」をご参照ください。

      zh-Hans

      kIdentityParamKeyDefaultLanguage

      デフォルトの SDK 言語を設定します。有効な値の一覧は、kIdentityParamKeyLanguage を参照してください。

      デフォルト値は en (English) です。

      en

      kIdentityParamKeyCloseButtonPosition

      SDK UI における閉じるボタンの位置。

      • left (デフォルト)

      • right

      left

      kIdentityParamKeyWatermark

      OCR 認識が成功した後に表示されるウォーターマークのテキスト。

      Test watermark text

      kIdentityParamKeyProtocol

      SDK のプロトコル。

      説明

      サーバー側の Initialize API を呼び出して protocol を取得し、このパラメータに渡します。これにより SDK 内部での API のやり取りが減り、ネットワークパフォーマンスが向上します。

      968412EB*******...

      次の例は、パラメーターを渡す方法を示しています:

      // Android の場合
      aliyunVerify.startVerify({
        transactionId: "<verification_id>", // サーバーから取得した transactionId を入力します。
        SdkLanguage: "zh-Hans" // 拡張パラメーターでフィールドを渡します。
      }, function(t){
        console.log(t)
      });
      
      // レスポンス形式
      {
        code: 1000, // エラーコード
        message: "CODE_VERIFY_SUCCESS" // エラーコードの説明
      }
  5. setCustomUI() インターフェイスを呼び出して、UI カラーをカスタマイズします。

    params:データを JSON 形式で渡します。UI カスタマイズ設定の詳細については、ネイティブ SDK のドキュメントをご参照ください:

完全なコード例

<template>
  <view class="button-sp-area">
  <button type="primary" plain="true" @click="init">init</button>
  <button type="primary" plain="true" @click="getMetaInfo">getMetaInfo</button>
  <button type="primary" plain="true" @click="verify">verify</button>
  <button type="primary" plain="true" @click="setCustomUi">setCustomUi</button>
		
  </view>
</template>

<script>
const aliyunVerify = uni.requireNativePlugin('VerifyIntlUniPlugin');
	
export default {
  data() {
    return {
      title: ''
    }
  },
  onLoad() {
			
  },
  methods: {
    init:function() {
      console.log("init");
      const json={
        CustomUrl:"https://cloudauth-device.ap-southeast-5.aliyuncs.com",
        CustomHost:"cloudauth-device.ap-southeast-5.aliyuncs.com"
      };
      aliyunVerify.initWithOptions(json);
    },
    getMetaInfo:function() {
      console.log("getMetaInfo");
      var t = aliyunVerify.getMetaInfo();
      console.log(t);
      uni.showToast({
        title: t,
        icon: 'none'
      });
    },
    setCustomUi:function(){
      const json={
        faceConfig:{faceBGColor:"#FF00FF"}
      };
      var t = aliyunVerify.setCustomUI(JSON.stringify(json));
      console.log("setCustomUi"+t);
    },
    verify:function(){
      console.log("Face Verify");
      aliyunVerify.startVerify({
          transactionId: "xxxxx", // 検証 ID
        }, 
       function(t){
         console.log(t);
         const msg = JSON.stringify(t);
         console.log(msg);
         // uni.showToast({
         // 	title: t,
         // 	icon: 'none'
         // });
       });
    }
  }
}
</script>
<style>
button {
  margin-top: 30upx;
  margin-bottom: 30upx;
}

.button-sp-area {
  margin: 0 auto;
  width: 60%;
}

.content {
  text-align: center;
  height: 400upx;
}

.wrapper {
  flex-direction: column;
  justify-content: center;
}

.button {
  width: 200px;
  margin-top: 30px;
  margin-left: 20px;
  padding-top: 20px;
  padding-bottom: 20px;
  border-width: 2px;
  border-style: solid;
  border-color: #458B00;
  background-color: #458B00;
}

.text {
  font-size: 30px;
  color: #666666;
  text-align: center;
}
</style>

SDK リリースノートに移動して UniApp Demo をダウンロードし、完全な例を表示することもできます。

重要

このデモコードは連携の参照用にのみ提供されています。アプリケーションには最新バージョンの SDK を使用するようにしてください。

エラーコード

エラーコード

説明

1000

検証に成功しました。

この結果は参照用です。サーバーサイドの CheckResult API を呼び出して、最終的な検証結果を取得してください。

1001

検証に失敗しました。

失敗の詳細な理由を取得するには、サーバーサイドの CheckResult API を呼び出してください。

1002

システムエラー。

1003

SDK の初期化に失敗しました。クライアントの時刻が正しいか確認してください。

1004

カメラの権限エラー。問題を解決するには、次の手順を試してください:

  1. 検証の前に、アプリにカメラの権限があることを確認してください。

  2. 権限を付与しても権限エラーが解決しない場合は、アプリのキャッシュをクリアして再試行してください。

1005

ネットワークエラー。

1006

ユーザーが終了しました。

1007

無効な TransactionId。

1009

クライアントタイムスタンプエラー。

1011

送信された証明書の種類が正しくありません。

1012

検出された証明書の主要な情報が欠落しているか、形式チェックに失敗しました。

1013

画質が低すぎます。

1014

エラー回数が上限を超えました。

1015

Android システムのバージョンが低すぎます。

1016

カメラの権限が付与されていません。