Getting started with AML integration
To integrate ZOLOZ with your application, please use the phased approach described below to prepare for integration and testing, implement the integration solution and test the product.
Figure 1. Integration flow
As Figure 1 shows, 3 phases are involved in the ZOLOZ AML integration:
In order to be ready for the integration implementation, please perform the following actions first:
1. Plan your integration
Before making any concrete actions, make a plan for your integration process：
a. Choose the development environment
ZOLOZ AML provides separate testing and production environments. You can choose different environments as required. It is strongly recommended that you implement and test your integration solution in the test environment first before going live in the production environment.
b. Obtain the corresponding service endpoints for access
For different environments, the service endpoints that you need to access, including the ZOLOZ AML portal and base API URI, are different. To find out more information about the environment and its related service endpoints, see Understanding environments and service endpoints.
2. Set up your ZOLOZ portal account
a. Contact the ZOLOZ AML BD team you are working with to open a tenant and admin account
You will need to provide your email address and use cases. Once the account is ready, you will receive an email containing a username and password.
b. Log in to the ZOLOZ portal and change your password
Navigate to the ZOLOZ portal for your specified development environment in your web browser, and login with your username and password.
If this is your first time logging in, you will be asked to change your password. After changing the password, you will be redirected back to the portal homepage.
Figure 2. ZOLOZ AML Login Interface
Figure 3. Password Reset Interface
Figure 4. Portal Homepage
3. Get API credentials ready
To ensure message transmission security between your business and ZOLOZ's services, you will need to prepare the following API credentials to use for a successful gateway integration:
- Client ID: the unique identifier of your account, which is used to trace your transaction. It is generated when your account is created and can be obtained from the ZOLOZ portal.
- ZOLOZ transaction public key: the public key that you can use to encrypt your requests or validate response signatures returned from ZOLOZ. It is generated when your account is created and guaranteed to be unique. You can obtain it from the ZOLOZ portal.
- Your transaction key pair: the key pair that is provided by you. Your public key must be registered in the ZOLOZ system so that the ZOLOZ service can use the key to validate the signature of your request or encrypt the response returned to you. You can use the ZOLOZ portal to automatically generate a key pair for convenience, or generate it by yourself.
For more information about how to get the API credentials ready, see Get API credentials ready for use.
4. Integrate the ZOLOZ gateway
To integrate with the ZOLOZ API, you must firstly integrate the ZOLOZ gateway so that API requests and responses can be transmitted and handled correctly. For more information, see Integrate the ZOLOZ gateway.
Follow the relevant integration guide below when needed:
- API integration
Once you complete the integration, you can test your product to verify whether the integration is successful. It is strongly recommended that you implement and test your integration solution in the test environment first before going live in the production environment.
You can use following requests to test API.
The following example is a non-hit list case:
The following example is a hit list case:
To find out the details of XXX in "XXX", such as in "tenantID": "XXX" and "tntInstID": "XXX", please contact ZOLOZ BD/Solution team.