Getting started integrating

Updated at:
Copy as MD

Integrate ZOLOZ with your application by completing three sequential phases: prepare your account and credentials, implement the integration, and test.

image

Figure 1. Integration flow

As Figure 1 shows, 3 phases are involved in the ZOLOZ integration:

Prepare

Complete the following preparation steps before writing any code.

1. Plan your integration

Identify the service endpoints you need and choose an integration mode.

Find your service endpoints

The ZOLOZ portal URL and base API URI differ by environment. For a list of environments and their service endpoints, see Understand service endpoints.

Choose an integration mode

ZOLOZ supports three integration modes. Use the table below to select the one that fits your application.

Integration mode

Best for

How it works

Native App SDK

iOS or Android apps

Embed the SDK directly in your mobile app for native performance and camera access.

Mobile Web HTML5 (H5)

Mobile web apps or modern mobile browsers

Embed a web-based verification flow in your mobile web application.

Pure API

Server-side applications

Call ZOLOZ APIs directly from your server without a client-side component.

For detailed information about each mode and supported products, see Understand integration modes.

2. Set up your ZOLOZ portal account

Set up your admin account

The ZOLOZ admin account is linked to your Alibaba Cloud account. Use either of the following methods to access the ZOLOZ console.

  • Method 1: Open Alibaba Cloud and sign in. Click Console at the top of the page. In the search box, type ZOLOZ and select Trusted Financial Engine to go to the ZOLOZ console.icms登录控制台03.pngicms登录控制台04.png

  • Method 2: While signed in to your Alibaba Cloud account, open the ZOLOZ Real ID product page. Find Open online - Start docking and click ZOLOZ Console.icms登录控制台01.pngicms登录控制台02.png

The admin account password is managed through Alibaba Cloud, not through the ZOLOZ console. To change your password, see the FAQ.

After activating the product, go to the ZOLOZ console and click ZOLOZ Portal to access the portal.ZOLOZ控制台1–截图.pngZOLOZ AML控制台-截图.png

Set up sub-accounts

After signing in with your Alibaba Cloud main account and accessing the ZOLOZ console, you can create sub-accounts. Sub-accounts can sign in to the ZOLOZ console directly, without going through Alibaba Cloud.

image

3. Get API credentials ready

Three API credentials secure communication between your application and ZOLOZ. Prepare all three before proceeding to gateway integration.

  • Client ID: A unique identifier for your account, used to trace your transactions. Generated when your account is created and available in the ZOLOZ portal.

  • ZOLOZ transaction public key: A public key issued by ZOLOZ. Use it to encrypt requests sent to ZOLOZ and to verify signatures on responses from ZOLOZ. Generated when your account is created and available in the ZOLOZ portal.

  • Your transaction key pair: A key pair you generate and own. Register your transaction public key in the ZOLOZ portal so ZOLOZ can verify your request signatures and encrypt responses back to you. You can generate the key pair automatically in the ZOLOZ portal or generate it yourself.

For step-by-step instructions on obtaining these credentials, see Get API credentials ready for use.

4. Integrate the ZOLOZ gateway

Before calling any ZOLOZ API, integrate the ZOLOZ gateway so that API requests and responses are transmitted and handled correctly. For instructions, see Interact with the ZOLOZ gateway

Integration

The integration steps depend on the mode you selected in step 1.

  • Pure API mode involves only server-side integration with ZOLOZ APIs.

  • Native App SDK mode and Mobile Web HTML5 (H5) mode involve both server-side and client-side integration.

Follow the guide for your integration mode:

Test

After completing integration, test your product to verify it is working correctly.

Before your free trial quota is exhausted, purchase the setup fee to continue using ZOLOZ services. For the purchase steps, refer to How to purchase the setup fee.

FAQ

How do you modify the password for an administrator account?

The admin account password is managed through Alibaba Cloud, not through the ZOLOZ console. To change it:

  1. Go to the Alibaba Cloud official website and sign in. Hover over the user avatar in the top-right corner and click Account Management in the menu.

image

  1. On the Account Management page, find Login Password and click Change.image

  2. Enter the verification code sent to your phone number or email address, then follow the on-screen prompts to complete the password change.

image