zkMe Dochub
GitHubTwitterDiscord
  • zkMe Network
  • Learn about zkMe Network
    • Introduction
    • Try a Demo
    • High Level Architectural Overview
      • High Level User Stories
      • zkMe Protocol Components
        • zkMe zkVault
        • zkMe DID Method
        • zkMe Credential Suites
        • zkMe Self-Sovereign Identity
    • Vision, Mission & Design Philosophy
    • Value Propositions & Use Cases
  • Verify with zkMe Protocol
    • Integration Checklist
      • zkMe Dashboard Setup
      • zkMe Supported Chains Overview
      • zkMe Protocol Smart Contract
    • Integration Guide
      • JavaScript SDK
        • zkKYC - Compliance Suite
        • MeID - Anti-Sybil Suite
        • Me - Profiling Suite
      • zkMe API
        • zkKYC - Compliance Suite
          • Verify zkKYC Status
          • Get KYT Results
      • Platform Integration
        • QuestN Integration
      • Smart Contract Verification
        • Compliance Suite
      • Customize Widget UI
    • zkKYC - Compliance Suite
      • zkMe zkKYC Levels
      • Regulatory Frameworks
        • EU - MiCA/TFR Regulations
        • US - Crypto Regulations
        • UK - Crypto Regulations
      • zkKYC Credentials
        • Proof-of-Citizenship (zkPoC)
        • Proof-of-Location (zkPoL)
        • Proof-of-Accredited-Investor (zkPoAI)
        • AML Check (AMLMe)
        • Know Your Transaction (KYT)
          • KYT Supported Scope
        • Know Your Business (KYB)
    • MeID - Anti-Sybil Suite
      • CKKS Homomorphic Encryption
      • DID Creation
      • MeID Credentials
        • MeID
    • Me - Profiling Suite
      • MeScores Credentials
        • zkCredit Score
        • zkSocial Network
        • zkDAO Management
        • zkGaming Status
    • zkMe Roadmap
  • Explore More
    • zkMe Bug Bounty Program
    • zkMe Brand Kit
    • zkMe Identity Hub
    • FAQ
    • Glossary
    • Link
      • GitHub
      • X / Twitter
      • Medium
      • YouTube
      • LinkedIn
      • Discord
      • Blog
    • Privacy Policy
Powered by GitBook
On this page
  • Get KYC statistics status #
  • Get Users List
  • Get Users KYC Result Overview
  1. Verify with zkMe Protocol
  2. Integration Guide
  3. zkMe API
  4. zkKYC - Compliance Suite

Verify zkKYC Status

PreviouszkKYC - Compliance SuiteNextGet KYT Results

Last updated 1 month ago

Before initiating the request to obtain the status from Get KYC statistics status # and Get Users List, please follow at zkMe API to get your API access parameters.

Get KYC statistics status

https://openapi.zk.me/kyc/v1/status
    ?mch_no=YourMerchantNumber
    &api_key=YourApiKey

Parameters

Name
Type
Description

mch_no

string

api_key

string

Your API key

Sample Response

{
  "code": 200,
  "message": "success",
  "data": {
    "kyc_participants": 22,
    "kyc_verified": 0,
    "kyc_participants_daily": [
      {
        "date": "2023-07-27",
        "participants": 2
      },
      {
        "date": "2023-07-28",
        "participants": 1
      },
      {
        "date": "2023-08-09",
        "participants": 1
      },
      {
        "date": "2023-08-13",
        "participants": 2
      },
      {
        "date": "2023-09-14",
        "participants": 1
      },
      {
        "date": "2023-09-25",
        "participants": 1
      },
      {
        "date": "2023-10-27",
        "participants": 2
      },
      {
        "date": "2023-12-01",
        "participants": 1
      },
      {
        "date": "2024-01-05",
        "participants": 1
      },
      {
        "date": "2024-01-06",
        "participants": 1
      },
      {
        "date": "2024-01-10",
        "participants": 2
      },
      {
        "date": "2024-01-15",
        "participants": 1
      },
      {
        "date": "2024-01-16",
        "participants": 1
      },
      {
        "date": "2024-01-17",
        "participants": 3
      },
      {
        "date": "2024-01-19",
        "participants": 1
      },
      {
        "date": "2024-01-24",
        "participants": 1
      }
    ],
    "kyc_verified_daily": null,
    "meid_count": 4
  }
}

Get Users List

Returns a list of users who have authorized a Soulbound Token under this project account.

https://openapi.zk.me/kyc/v1/users
   ?mch_no=YourMerchantNumber
   &api_key=YourApiKey
   &page=1
   &num=10

Parameters

Name
Type
Description

mch_no

string

api_key

string

Your API key

page

int

Page number, example value: 1

num

int

Number of data entries per page.

Sample response

{
  "code": 200,
  "message": "success",
  "data": {
    "data": [
      {
        "zkme_id": "...",
        "verify_time": "",
        "account": "...",
        "blockchain_id": ...,
        "blockchain_logo_url": "...",
        "program_type": "...",
        "network": "",
        "token_id": "...",
        "user_wallet_address": "...",
        "authorization_info": null,
        "user_id": "",
        "ssi_wallet_address": ""
      }
    ],
    "page": {
      "page": 1,
      "num": 10,
      "total": 1
    }
  }
}

Get Users KYC Result Overview

Returns the balance and statistics for a given address.

POST https://agw.zk.me/zkseradmin/openapi/queryKycInfoByAddress

Request Body

{
  "mchNo": "YourMerchantNumber",
  "apiKey": "YourApiKey",
  "programNo": "YourProgramID",
  "account": "walletAddress", // or email, or other unique identifiers
  "chainId": "YourChainID"
}

Fields Explanation

Name
Type
Description

mchNo

string

apiKey

string

Your API Key.

programNo

string

Same as the programNo you pass for the SDK integration.

account

string

User's wallet address (recommended), email address, or other unique identifier

chainId

string

Same as the param chainId you pass for the SDK integration.

Supported Chain List

Chain Type
Chain Name
Chain ID

Mainnet

Aptos

aptos-1

Arbitrum

42161

Base

8453

BNB Smart Chain

56

BounceBit

6001

Ethereum

1

Manta

169

Neutron

neutron-1

Polygon

137

Ronin

2020

X Layer

196

Testnet

Aptos Testnet

aptos-2

Lumoz Testnet

12008

Manta Testnet

3441005

Mantle Testnet

5001

Neutron Testnet

pion-1

Plume Testnet

98864

Scroll Sepolia Testnet

534351

Sei Testnet

atlantic-2

ZetaChain Athens3 Testnet

7001

Sample Response

{
  "zkme_id":"...",
  "kycStatus":"...",
  "kycCompleteTimeUnix":"...", 
  "ssiAddress":"...",
  "verifierValues":{
    "sanction":...,
    "age":...,
    "citizenship":...,
    "location":...,
  },
}

Fields Explanation

Name
Type
Description

zkme_id

String

Return the zkMe id corresponding to the zkMe account linked to the provided address.

kycStatus

string

Return users' KYC status, including 7-8 stages:

  • Verification Started

  • OCR Passed

  • Liveness Checked

  • ZKP Generated

  • SBT Minted

  • OnChain Minted

  • KYC Passed

  • Verification Failed

kycCompleteTimeUnix

string

Unix timestamp of the mint time of SBT minting in SSI wallet.

ssiAddress

String

User's SSI wallet address

sanction

bool

Return the user's AML Screening verification result with the following output:

  • If the user passes, return true.

  • If the user fails, return false.

  • If the AML Screening verification is not configured for the program, return null.

age

bool

Return the user's age verification result with the following output:

  • If the user passes, return true.

  • If the user fails, return false.

  • If the Proof of Citizenship is not configured for this program, return null.

citizenship

bool

Return the user's citizenship verification result with the following output:

  • If the user passes, return true.

  • If the user fails, return false.

  • If the Proof of Citizenship is not configured for the program, return null.

location

bool

Return the user's location verification result with the following output:

  • If the user passes, return true.

  • If the user fails, return false.

  • If the Proof of Location is not configured for the program, return null.

Same as AppID in the .

Same as AppID in the .

Same as AppID in the .

Note: Only applicable to and

Dashboard
Dashboard
Dashboard
#
#
#
Authentication
On-chain Mint
On-chain Transactional