This document introduces the complete process of manually integrating the ZOLOZ HarmonyOS SDK.

Prerequisites

Before integrating the ZOLOZ HarmonyOS SDK, ensure that your DevEco Studio version is 5.0.5 or later.

Products supported

The ZOLOZ HarmonyOS SDK supports the following products:

• RealID
• ID Recognition
• Face Capture
• Connect

Procedures

Step 1: Download and Install SDK

1. Open the ZOLOZ HarmonyOS repository.
2. Select the desired ZOLOZKit version (it is recommended to use the latest version), and download the corresponding zolozkit.har package.
3. Drag the downloaded SDK file (.har) into the libs directory of your project.

4. Add the following dependency configuration in the oh-package.json5 file of the module that needs to integrate the ZOLOZKit SDK.

{
    "dependencies": {
      // ./libs/zolozkit.har should be replaced with the actual path of zolozkit.har
        "zolozkit": "file:./libs/zolozkit.har"
    }
}

Step 2: Verify HAR Integration

After configuring the dependency in oh-package.json5 and syncing the project, it is recommended to add the following test code to your project. If the metainfo string can be obtained successfully, the SDK has been correctly integrated.

// Import ZOLOZ
import { ZolozFacade } from "zolozkit";

// Test calling ZolozFacade getMetaInfo
const metainfo = ZolozFacade.getMetaInfo();

Step 3: Start the ZOLOZ SDK

Run the following code to import the SDK and start the verification process:

// Import ZOLOZ
import { ZolozFacade, ZolozRequest, ZolozResponse, ZLZResponseCode } from "zolozkit";

// Build request
const request = new ZolozRequest(clientCfg, { rsaPubKey });

// Start the SDK
const response: ZolozResponse = await ZolozFacade.getInstance().startWithRequest(getContext(this), request);

// Handle result based on response code
if (response.code === ZLZResponseCode.Interrupt) {
  // User exited or system interrupted; the SDK has already shown a prompt internally
} else {
  // The flow completed normally; call the backend checkResult API to obtain the transaction result (the backend service is the source of truth)
}