Android SDK integration

Prerequisites

The SDK requires a phone or tablet running Android 4.0.3 (minSdkVersion ≥ 15) or later.

Permission description

This SDK requires the following permissions to enhance security.

Download and configure the SDK

1. Download the Enhanced Real-Person Authentication SDK (Android) to your local device and extract the files. The SDK is a standard Android .aar package.

2. Import all the extracted .aar files into the /libs directory of your app project and add the following dependencies to your app's build.gradle file:

   // SDK modules.
   implementation files('libs/aliyun-identityplatform-xxx.aar')
   implementation files('libs/aliyun-identityocr-xxx.aar')
   implementation files('libs/aliyun-identityface-xxx.aar')
   implementation files('libs/Android-AliyunFaceGuard-xxx.aar')
   implementation files('libs/aliyun-identitycrypto-xxx.aar')
   
   // Third-party SDK dependencies.
   implementation 'com.android.support:appcompat-v7:28.0.0'
   implementation 'com.squareup.okhttp3:okhttp:3.11.0'
   implementation 'com.squareup.okio:okio:1.14.0'
   implementation 'com.aliyun.dpa:oss-android-sdk:2.9.11'
   implementation 'com.alibaba:fastjson:1.2.83_noneautotype'

Function reference

The Enhanced Real-Person Authentication SDK includes three main functions: install for SDK initialization, getMetaInfo for retrieving device information, and faceVerify for starting the authentication process. The following sections provide detailed descriptions of these functions.

Initialize the SDK (install function)

• Description:

  Call this function to initialize the SDK. You can configure delayed initialization so that the SDK for facial recognition scenarios is initialized only after the user accepts the Privacy Policy.

• Function prototype:

  public void install(Context context);

• Parameters:

  Name	Type	Description
  context	Context	The application context.

• Return value:

  None.

getMetaInfo function

• Description:

  Call this function to retrieve the environment context of the mobile device and send the information to the App Server.

  The App Server uses this information as the MetaInfo parameter to call the InitSmartVerify API. This call returns a CertifyId for subsequent validation.

• Function prototype:

  String metaInfo = IdentityPlatform.getInstance().getMetaInfo(MainActivity.this);

• Parameters:

  Name	Type	Description
  context	Context	The context of the current activity.

• Return value:

  Returns the environment context of the mobile device in JSON format. The following code shows a sample return value:

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

Return values

The server returns the validation result in the IdentityResponse.code parameter. The following table describes the possible values.

Sample code

public class MainActivity extends AppCompatActivity {
    
    private String certifyId = "";

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

        // Initialize the SDK. We recommend waiting about 3 seconds after calling install before calling other verification APIs.
        IdentityPlatform.getInstance().install(MainActivity.this);
        
        // Get the MetaInfo.
        String metaInfo = IdentityPlatform.getMetaInfo(MainActivity.this);
        
        // Send the MetaInfo to your app server to call the server-side InitSmartVerify API and get the CertifyId.
        // certifyId = getCertifyIdFromServer(metaInfo);
        
        // Start the verification.
        IdentityPlatform.getInstance().faceVerify(certifyId, null,
          new IdentityCallback() {
            @Override
            public boolean response(final IdentityResponse response) {
                if (IdentityResponseCode.IDENTITY_SUCCESS == response.code) {
                    Toast.makeText(MainActivity.this,
                                   "Authentication passed", Toast.LENGTH_LONG).show();
                } else {
                    Toast.makeText(MainActivity.this,
                                   "Authentication failed([" + response.code + "]" + response.message + ")",
                                   Toast.LENGTH_LONG).show();
                }
                return true;
            }
        });
    }
}

API obfuscation configuration

-verbose
-keep class com.aliyun.identity.face.** {*;}
-keep class com.aliyun.identity.ocr.** {*;}
-keep class com.aliyun.identity.platform.** {*;}
-keep class com.ant.phone.xmedia.algorithm.** {*;}
-keep class com.alipay.zoloz.** {*;}
-keep class net.security.device.api.** {*;}

-keep class com.darsh.multipleimageselect.** { *; }
-dontwarn com.darsh.multipleimageselect.**

-keep class com.soundcloud.android.crop.** { *; }
-dontwarn com.soundcloud.android.crop.**
-keep class com.aliyun.identity.IdentityUtils {*;}

Demo package

Enhanced Liveness Verification Demo (Android)