Verify zkKYC Status

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

Get KYC statistics status

URL

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

Request

Parameters #

Name	Type	Description
mch_no	string	Same as AppID in the Dashboard.
api_key	string	Your API key

Response

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.

URL

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

Request

Parameters#

Name	Type	Description
mch_no	string	Same as AppID in the Dashboard.
api_key	string	Your API key
page	int	Page number, example value: 1
num	int	Number of data entries per page.

Response

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 verification status of the user for the following credentials: Proof-of-Citizenship (zkPoC), Proof-of-Location (zkPoL), and AML Check (AMLMe).

Endpoint

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

Request

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	Same as AppID in the Dashboard.
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

Mainnet

Chain Name	zkMe Chain ID
Aptos	aptos-1
Arbitrum	42161
Base	8453
BNB Smart Chain	56
BounceBit	6001
Ethereum	1
Kaia	8217
Manta	169
Neutron	neutron-1
Polygon	137
Ronin	2020
Solana	solana
TON	ton

Testnet

Chain Name	zkMe Chain ID
Aptos Testnet	aptos-2
Plume Testnet	98864
Scroll Sepolia Testnet	534351
Sei Testnet	atlantic-2
ZetaChain Athens3 Testnet	7001

Response

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 Note: Only applicable to On-chain Mint and On-chain Transactional 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.

Get Users Accredited Investor Status Overview

Returns the verification status of the user for the following credentials: Proof-of-Accredited-Investor (zkPoAI).

Endpoint

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

Request

Request Body

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

Fields Explanation

Name	Type	Description
mchNo	string	Same as AppID in the Dashboard.
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. Currently supports Polygon (137) and Base (8453).

Supported Chain List

Mainnet

Chain Name	zkMe Chain ID
Aptos	aptos-1
Arbitrum	42161
Base	8453
BNB Smart Chain	56
BounceBit	6001
Ethereum	1
Kaia	8217
Manta	169
Neutron	neutron-1
Polygon	137
Ronin	2020
Solana	solana
TON	ton

Testnet

Chain Name	zkMe Chain ID
Aptos Testnet	aptos-2
Plume Testnet	98864
Scroll Sepolia Testnet	534351
Sei Testnet	atlantic-2
ZetaChain Athens3 Testnet	7001

Response

Sample Response

{
  "poaiCompletedTimeUnix":"...",
  "poaiStatus":"...",
  "ssiAddress":"...",
  "zkmeId":"...",
}

Fields Explanation

Name	Type	Description
poaiCompletedTimeUnix	string	Unix timestamp of the mint time of user completed the share data process and minted a SBT in SSI wallet.
poaiStatus	string	Return users' zkPoAI status, including 6 stages: Verification Started Data Retrieved ZKP Generated SBT Minted OnChain Minted Note: Only applicable to On-chain Mint and On-chain Transactional PoAI Passed (or PoAI Failed)
ssiAddress	string	User's SSI wallet address
zkmeId	string	Return the zkMe id corresponding to the zkMe account linked to the provided address.