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

ID Verification:UniApp 統合

最終更新日:Nov 19, 2025

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

開始する前に

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

依存関係の構成

UniApp プラグインを統合するには、「DCloud 公式ドキュメント」をご参照いただくか、次のステップに従ってください。

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

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

    1. manifest.json ファイルで、[App Native Plugin Configuration] をクリックします。

    2. [App Native Plugin Configuration] セクションで、[Select Local Plugin] をクリックします。

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

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

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

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

      説明

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

サービスの呼び出し

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

    options: 情報収集のためのオプションパラメーターを指定します。このパラメーターはオプションです。オプションパラメーターは次のとおりです。

    説明
    • ID Verification クライアントには、Device Guard セキュリティモジュールが組み込まれています。さまざまなリージョンのデータ収集コンプライアンス要件を満たすために、さまざまなデータレポートサイトを提供します。ユーザー属性に基づいてレポートサイトを指定するために、CustomUrl と CustomHost を設定できます。

      注: 1 つのアプリケーションセッションライフサイクル内で指定できるレポートサイトは 1 つだけです。サーバークエリリージョンはレポートサイトと一致する必要があります。

    • レポートサイトの指定:

      • シンガポールサイト (デフォルト): 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.cn-hongkong.aliyuncs.com

    • プロダクトサーバーでサポートされているリージョンの詳細については、「サポートされているリージョン」をご参照ください。

    フィールド名

    説明

    IPv6

    IPv6 ドメイン名を使用してデバイス情報をレポートするかどうかを指定します:

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

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

    "1"

    DataSwitch

    デバイス情報をレポートするタイミング。

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

    • 1: トークン取得時

    説明

    デフォルトの構成を使用することをお勧めします。

    "1"

    CustomUrl

    データレポートサーバーのドメイン名を設定します。

    "https://cloudauth-device.ap-southeast-1.aliyuncs.com"

    CustomHost

    データレポートサーバーのホストを設定します。

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

  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.ShowAlbumIcon

      証明書 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 はモバイルデバイスのシステム言語を使用します。

      説明

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

      zh-Hans

      IdentityParams.CloseButtonLayout

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

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

      • right: 右側

      left

      IdentityParams.WaterMark

      OCR スキャンが成功した後のウォーターマークテキスト。

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

      IdentityParams.Protocol

      SDK プロトコル。

      説明

      サーバー側の Initialize API から `protocol` を取得し、拡張パラメーターで渡します。これにより、SDK 内の内部 API のやり取りが減り、ネットワークエクスペリエンスが向上します。

      なし

      iOS

      キー

      説明

      例 (文字列)

      kIdentityParamKeyNextButtonColor

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

      #FF0000

      kIdentityParamKeyRoundProgressColor

      顔スキャン中の円の色。

      #FF0000

      kIdentityParamKeyOcrSelectPhoto

      証明書 OCR 中にフォトアルバムからのアップロードエントリを表示するかどうかを指定します:

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

      • 0: 表示しない

      1

      kIdentityParamKeyShowOcrResult

      証明書 OCR 後に結果ページを表示するかどうかを指定します:

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

      • 0: 表示しない

      1

      kIdentutyParamKeyEditOcrResult

      証明書 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 はモバイルデバイスのオペレーティングシステムの言語を使用します。

      説明

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

      zh-Hans

      kIdentityParamKeyDefaultLanguage

      SDK のデフォルト言語設定。有効な値については、kIdentityParamKeyLanguage フィールドをご参照ください。

      デフォルト値は en で、英語を示します。

      en

      kIdentityParamKeyCloseButtonPosition

      SDK の閉じるボタンの位置:

      • left (デフォルト): 左

      • right: 右

      left

      kIdentityParamKeyWatermark

      OCR が成功した後のウォーターマークテキスト。

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

      kIdentutyParamKeyProtocol

      SDK プロトコル。

      説明

      サーバー側の Initialize API からプロトコルを取得し、拡張パラメーターで渡します。これにより、SDK 内の内部 API のやり取りが減り、ネットワークエクスペリエンスが向上します。

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

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

      // Android の場合、
      aliyunVerify.startVerify({
        transactionId:"<verification_id>",// サーバーから取得した transactionId を入力します。
        SdkLanguage:"cn"// 拡張パラメーターでフィールドを渡します。	
      }, 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>

また、UniApp デモをダウンロードして、完全な例を表示することもできます。

重要

このデモコードは、統合リファレンスとしてのみ提供されています。アプリケーションには最新の 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

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