SDK Integration
Anti-Sybil SDK - A rapid and privacy-preserving solution to combat bot and sybil attacks by using the RedirectURL as the src-attribute value for the iFrame.
Use Case
When you need to protect a website or application from automated attacks, you can use anti-bot mechanisms. These attacks can result in malicious behavior, such as spamming, data theft, or network disruption. Anti-bot technology is designed to identify and block these attacks to ensure that only real human users can access your website or application.
In this case, users are required to undergo facial liveliness detection to prove that they are real human users. This detection requires users to perform specific actions or expressions in front of a camera to prove that they are genuine humans and not automated programs. This technology can help prevent automated attacks and fraud, and increase the security and reliability of your website or application.
zkMe-Widget MeID Process
Step 1: Enter the service authorization Widget page, the user confirms and goes to the next step
Step 2: E-mail verification login / Wallet address login
Step 3: Verify that the user has authorized MeID
Step 4: Based on the outcomes of the initiated query, a determination is made regarding whether to commence the authentication process for the specified user.
Interaction Instructions
Integration via NPM
You can refer to @zkmelabs/widget and please make sure to use the latest version.
Installation
Getting Started
Step 1. Import styles
Step 2. Create a new ZkMeWidget
instance
ZkMeWidget
instanceNOTE: The specific configuration for the "option" parameter is shown in the table below
Para | Type | Description |
---|---|---|
options.lv | VerificationLevel? |
|
Step 3. Listen to the finished
widget events to detect when the user has completed the MeID process
Step 4. Launch the zkMe widget and it will be displayed in the center of your webpage
Helper functions
verifyWithZkMeServices
Before launching the widget, you should check the MeID status of the user and launch the widget when the check result is false
.
Param | Type | Description |
---|---|---|
appId | string | This parameter means the same thing as "mchNo" |
userAccount | string | Same value as in |
lv | VerificationLevel? |
|
Exchanging API_KEY for Access Token
To use your API_KEY to obtain an accessToken, you will need to make a specific HTTP request. Here's how you can do it:
a. Endpoint: Send a POST
request to the token exchange endpoint.
Please remember to modify the Content-Type
in the request header to application/json
. Failing to do so might result in a Parameter Error
response.
b. Request Body:
Parameter Name | Required | Type | Desc |
---|---|---|---|
apiKey | True | string | The API_KEY provided by zkMe. |
appId | True | string | A unique identifier (mchNo) to DApp provided by zkMe. |
apiModePermission | True | number | 0-email login 1-wallet address login |
lv | True | number | The parameter must be passed and always be 2. |
API_KEY
you can get this from the zkMe Biz dashboard.
c. Response
Success
Exception (AppId and API_KEY not matched)
Exception (Parameter Error)
Exception (System Error)
Response & Exceptions
Smart Contract Workflow
Regarding smart contract workflow, please refer to this
Last updated