ID Verification:App SDK integration flow

Procedure

1. Activate the ID Verification service. For more information, see Activate the ID Verification service.

2. Review the App (SDK) and Server-side integration method.

   1. Call the server-side initialization API.

   2. Integrate the client SDK.

   3. Call the server-side query API.

   The following time series chart shows the detailed integration flow.

   Step	Description
   1	The user starts a business process in the merchant app.
   2	The app calls the authentication SDK to get MetaInfo.
   3	The authentication SDK returns MetaInfo.
   4	The app sends an authentication request with MetaInfo to the application server.
   5	The application server calls the Initialize API to send an authentication request to the Alibaba Cloud server.
   6	The Alibaba Cloud server returns a TransactionId to the application server.
   7	The application server passes the TransactionId to the app.
   8	The app calls the authentication SDK.
   9	The authentication SDK sends the user-submitted authentication materials to the Alibaba Cloud server. Note If safe mode is enabled during the Initialize call, the device token is uploaded to the Singapore site, and a threat tag is returned for use with the authentication result.
   10	The Alibaba Cloud server determines the authentication result based on the materials and returns the result to the SDK.
   11	The SDK uses a callback function to instruct the app to get the authentication status.
   12	The app queries the application server for the authentication status.
   13	The application server calls the CheckResult API to query the authentication result from the Alibaba Cloud server.
   14	The Alibaba Cloud server returns the authentication result and related materials to the application server.
   15	The application server processes the authentication information and passes non-sensitive information to the app.

3. Integrate the service with the App (SDK) and Server-side APIs.

   1. Call the server-side initialization API: Initialize.

      Call this API to obtain the TransactionId, which the SDK requires to start the application. The TransactionId is the unique identifier for the ID Verification service and is used to link all API calls within a single authentication request. For more information, see Initialize.

   2. Integrate the SDK into your client application. For detailed instructions, see the documentation for your platform:

      • Android integration

      • iOS integration

      • Flutter integration

      • UniApp integration

   3. Call the server-side query API: CheckResult.

      After the authentication is complete, call this API on your server to retrieve the authentication status and related materials. For more information, see CheckResult.