ID Verification:Android 統合

クイックスタート

次の例は、SDK を初期化し、検証セッションを開始するための最小限のコードを示しています。

// ステップ 1: SDK を初期化します (アプリの起動時に 1 回呼び出します)
IdentityPlatform.getInstance().install(context);

// ステップ 2: デバイスメタデータを収集し、サーバーに送信します
String metaInfo = IdentityPlatform.getMetaInfo(context);

// ステップ 3: サーバーが metaInfo を使用して Initialize API を呼び出します
//         transactionId と protocol を返します

// ステップ 4: 検証を開始します
Map<String, String> extParams = new HashMap<>();
extParams.put(IdentityParams.PROTOCOL, protocol);

IdentityPlatform.getInstance().verify(transactionId, extParams,
    new IdentityCallback() {
        @Override
        public boolean response(final IdentityResponse response) {
            if (IdentityResponseCode.IDENTITY_SUCCESS == response.code) {
                // 仮合格 -- CheckResult API で確認します
            } else {
                // エラーまたは失敗を処理します
            }
            return true;
        }
    });

完全な動作例については、Android デモプロジェクト をダウンロードしてください。

前提条件

開始する前に、以下を確認してください。

• Android 4.3 (API レベル 18) 以降をターゲットとするアプリ

• ARM ベースのデバイス (x86 はサポートされていません)

• サーバーサイドの Initialize API を呼び出して取得した transactionId

必要な権限

SDK のダウンロードとセットアップ

1. Android SDK をダウンロードします。パッケージには AAR (Android Archive) ファイルが含まれています。

2. パッケージを解凍し、すべての AAR ファイルをプロジェクトの libs ディレクトリにコピーします。

3. 次の依存関係を build.gradle ファイルに追加します。

   xxx を実際の SDK バージョン番号に置き換えてください。リストされているすべてのサードパーティの依存関係は必須です。

      dependencies {
          // [必須] コアモジュール
          implementation files('libs/idv-identityplatform-xxx.aar')
          implementation files('libs/idv-identityface-xxx.aar')
          implementation files('libs/idv-identitycrypto-xxx.aar')
          implementation files('libs/idv-identitybase-sdk-xxx.aar')
          implementation files('libs/idv-identityservice-sdk-xxx.aar')
          implementation files('libs/idv-identityblink-sdk-xxx.intl.aar')
          implementation files('libs/idv-identitymnn-xxx.aar')
          implementation files('libs/tygerservice-xxx.aar')
          implementation files('libs/Android-AliyunFaceGuard-xxx.aar')
   
          // [eKYC に必須] OCR モジュール
          implementation files('libs/idv-identityocr-xxx.aar')
   
          // [オプション] 自動 OCR スキャン
          implementation files('libs/idv-identityocrservice-xxx.aar')
   
          // [オプション] 顔の品質とオクルージョン検出
          implementation files('libs/idv-identityquality-sdk-xxx.aar')
   
          // [オプション] NFC ドキュメント読み取り
          implementation files('libs/IDOCR_PubSDK_Android-1.0.0.aar')
          implementation files('libs/idv-identitynfc-xxx.intl.aar')
   
          // または、すべての AAR ファイルを一度に追加します (すべてのオプションモジュールが含まれます):
          // implementation fileTree(dir: "libs", includes: ["*.aar"])
   
          // サードパーティの依存関係
          implementation "androidx.appcompat:appcompat:1.5.0"
          implementation "androidx.activity:activity:1.7.0"
          implementation "androidx.recyclerview:recyclerview:1.0.0"
          implementation 'com.squareup.okhttp3:okhttp:4.9.3'
          implementation 'com.squareup.okio:okio:2.8.0'
          implementation 'com.aliyun.dpa:oss-android-sdk:2.9.21'
          implementation 'com.alibaba:fastjson:1.1.72.android'
      }

統合ワークフロー

SDK は、IdentityPlatform クラスを通じて 3 つのメソッド (install、getMetaInfo、および verify) を公開しています。

1. install()       SDK を初期化します
        |
2. getMetaInfo()   デバイスメタデータを収集し、サーバーに送信します
        |
3. サーバーサイド     MetaInfo を使用して Initialize API を呼び出し、transactionId と protocol を取得します
        |
4. verify()        transactionId を使用して検証を開始します
        |
5. コールバック        IdentityResponse の結果を処理します

// 基本的な初期化
IdentityPlatform.getInstance().install(context);

// オプション付きの初期化
Map<String, String> options = new HashMap<>();
options.put("CustomUrl", "https://cloudauth-device.ap-southeast-1.aliyuncs.com");
options.put("CustomHost", "cloudauth-device.ap-southeast-1.aliyuncs.com");
IdentityPlatform.getInstance().install(context, options);

public void install(Context context);
public void install(Context context, Map<String, String> options);

String metaInfo = IdentityPlatform.getMetaInfo(context);
// metaInfo をサーバーに送信します

public static String getMetaInfo(Context context);

{
  "apdidToken": "",
  "appName": "com.aliyun.identity.platform",
  "appVersion": "1.0.1",
  "bioMetaInfo": "5.1.0:11501568,4",
  "deviceBrand": "xxx",
  "deviceManufacturer": "xxx",
  "deviceModel": "xxx",
  "deviceType": "android",
  "identityVer": "1.0.0",
  "osVersion": "10",
  "sdkVersion": "1.0.9"
}

Map<String, String> extParams = new HashMap<>();
extParams.put(IdentityParams.PROTOCOL, protocol);

IdentityPlatform.getInstance().verify(transactionId, extParams,
    new IdentityCallback() {
        @Override
        public boolean response(final IdentityResponse response) {
            if (IdentityResponseCode.IDENTITY_SUCCESS == response.code) {
                // 仮合格 -- CheckResult API で確認します
            } else {
                // エラーまたは失敗を処理します
            }
            return true;
        }
    });

public void verify(String transactionId, Map<String, String> extParams, IdentityCallback callback);

public class IdentityResponse {
    public int code;       // 結果コード (結果コード表を参照)
    public String message; // 結果の説明
}

public interface IdentityCallback {
    boolean response(IdentityResponse response);
}

検証フローのカスタマイズ

SDK の動作をカスタマイズするには、これらのキーを extParams マップに渡します。

結果コード

IdentityResponse.code の値は、検証結果を示します。コード 1000 および 1001 のみが課金対象となります。

完全なコード例

public class MainActivity extends AppCompatActivity {
    private String transactionId = "";
    private String protocol = "";

    @Override
    protected void onCreate(Bundle savedInstanceState) {
        super.onCreate(savedInstanceState);
        setContentView(R.layout.activity_main);

        // ステップ 1: SDK を初期化します
        IdentityPlatform.getInstance().install(MainActivity.this);

        // ステップ 2: デバイスメタデータを収集します
        String metaInfo = IdentityPlatform.getMetaInfo(MainActivity.this);

        // ステップ 3: metaInfo をサーバーに送信します。
        //         サーバーが Initialize API を呼び出し、transactionId と protocol を返します。
        // transactionId = getTransactionIdFromServer(metaInfo).transactionId;
        // protocol = getTransactionIdFromServer(metaInfo).protocol;

        // ステップ 4: 拡張パラメーターを設定します
        Map<String, String> extParams = new HashMap<>();
        extParams.put(IdentityParams.PROTOCOL, protocol);
        extParams.put(IdentityParams.SdkLanguage, "en");

        // ステップ 5: 検証を開始します
        IdentityPlatform.getInstance().verify(transactionId, extParams,
                new IdentityCallback() {
                    @Override
                    public boolean response(final IdentityResponse response) {
                        if (IdentityResponseCode.IDENTITY_SUCCESS == response.code) {
                            Toast.makeText(MainActivity.this,
                                    "Verification passed", Toast.LENGTH_LONG).show();
                        } else {
                            Toast.makeText(MainActivity.this,
                                    "Verification failed ([" + response.code + "] " +
                                            response.message + ")",
                                    Toast.LENGTH_LONG).show();
                        }
                        return true;
                    }
                });
    }
}

transactionId と protocol の値はサーバーから取得する必要があります。コメントアウトされている getTransactionIdFromServer() 呼び出しを、実際のサーバー通信ロジックに置き換えてください。

ProGuard および R8 難読化ルール

プロジェクトでコードの縮小に ProGuard または R8 を使用している場合は、次のルールを ProGuard 設定ファイルに追加してください。

# ID Verification SDK コア
-verbose
-keep class com.idv.identity.platform.api.** {*;}
-keep class com.idv.identity.platform.log.** {*;}
-keep class com.idv.identity.util.IdentityUtils {*;}
-keep class com.idv.identity.ocr.IdentityOcrApi {*;}
-keep class com.idv.identity.platform.model.** {*;}
-keep class com.idv.identity.platform.config.** {*;}
-keep class com.idv.identity.face.IdentityFaceApi {*;}

# 顔検証と Device Guard
-keep class com.face.verify.intl.** {*;}
-keep class com.alibaba.fastjson.** {*;}
-keep class face.security.device.api.** {*;}
-keep class net.security.device.api.** {*;}
-keep class com.dtf.toyger.** { *; }
-dontwarn net.security.device.api.**
-dontwarn face.security.device.api.**

# 生体検知と品質検出
-keep class com.idv.identity.service.algorithm.** {*;}
-keep class com.idv.identity.base.algorithm.** {*;}
-keep class com.idv.identity.quality.QualityRouter {*;}
-keep class com.idv.identity.blink.BlinkRouter {*;}
-keep class com.idv.identity.service.IdentityFaceService {*;}
-keep class com.idv.identity.service.ocr.IdentityDocService {*;}

# OSS SDK
-keep class com.alibaba.sdk.android.oss.** { *; }
-dontwarn okio.**
-dontwarn org.apache.commons.codec.binary.**

# NFC (NFC モジュールがトリミングされている場合は削除)
-keep class com.idv.identity.nfc.IdentityNfcApi { *; }
-keep class org.jmrtd.** {*;}
-keep class net.sf.**{*;}
-keep class org.**{*;}
-keep class cn.**{*;}

# バンドルされた依存関係の警告を抑制
-dontwarn com.fasterxml.**
-dontwarn com.google.**
-dontwarn java.applet.Applet
-dontwarn java.awt.**
-dontwarn javax.**
-dontwarn org.**
-dontwarn retrofit2.**
-dontwarn springfox.documentation.spring.web.json.Json

# (オプション) リリースビルドでデバッグログを削除
-assumenosideeffects class android.util.Log {
    public static *** d(...);
}

モジュールのトリミング

アプリサイズを削減するために、オプションモジュールを削除します。

参考資料

• 「サポートされているリージョン」

• 「Android および iOS SDK のカスタム言語」