zkMe Docs
Ask or search…

zkKYC Integration Guide

This page describes how to onboard zkMe services

Onboard procedure

Service Integration
  • Provide your business Email account, we will open a zkMe dashboard account for you.
  • Customise everything and get the API key on dashboard based on your requirements.
  • Begin technical integration with your dApp.
Testing and Optimization
  • Execute functional, performance, and security testing.
  • Based on testing results, perform necessary optimizations and adjustments.
Training and Support
  • Prior to going live, conduct training sessions for the client's team to ensure they understand how to use zkMe service.
  • Provide necessary support to assist them in resolving any issues.
  • After all preparations, launch the service officially for the web3 dApps.
Continuous Service and Monitoring
  • Continuously monitor the performance of the service to ensure stability and reliability.
  • Based on client feedback and requirements, continuously optimize and upgrade zkMe service.

Integrate with zkMe

Step 1: Register with zkMe

The first step is to register your project with zkMe. This will involve providing some basic details about your project, such as its name, the nature of your project, and your contact information. You will also need to agree to zkMe's Terms of Service and Privacy Policy.

Step 2: Configure Verification Levels

Next, you'll need to configure the verification levels for your project. zkMe offers Basic, Standard, and Advanced levels of verification, and you can choose the one that best suits your project's needs. You can also configure any add-ons at this stage.

Step 3: Integrate zkMe API

Once you have registered and configured your verification levels, you'll need to integrate the zkMe API into your project. This will involve adding the appropriate code to your project to connect it with zkMe's servers. zkMe will provide documentation and technical support to assist with this process.

Step 4: User Onboarding

With the zkMe API integrated, you can now begin onboarding users. When a user signs up for your project, they will be directed to complete the zkMe verification process. The specifics of this process will depend on the verification level you have chosen:
  • For the Basic level, users will need to provide proof of personhood, complete a liveness check, and a uniqueness check.
  • For the Standard level, users will also need to provide proof of citizenship, and complete AML, KYT, ID document verification, Age of Majority checks, PEP/Sanction lists checks, and adverse media checks.
  • For the Advanced level, users will also need to verify that they are accredited investors.

Step 5: Verification Status

Once a user has completed the verification process, zkMe will return a verification status to your project. This will inform you whether the user has successfully completed the verification process and at what level.

Step 6: Ongoing User Management

After a user has been onboarded, zkMe provides tools for ongoing user management. This includes tools for monitoring user activity, re-verifying user identities if necessary, and managing user data in compliance with privacy laws and regulations.

Project-side zkKYC Onboarding