Verify zkKYC Status

Before initiating the request to obtain the status, 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	Your merchant number
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

Return the list of users who have authorized 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	Your merchant number
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 Get Users KYC Result Overview

Returns the balance and statistics for a given address.

URL

https://openapi.zk.me/kyc/v1/info
    ?mch_no=YourMerchantNumber
    &api_key=YourApiKey
    &network_id=...
    &zkme_id=User's zkMe ID

Request

Parameters

Name	Type	Description
mch_no	string	Your merchant number
api_key	string	Your API key
network_id	int	network id (required)
zkme_id	string	zkme id (required)

Response

Sample response:

{
  "code": 200,
  "message": "success",
  "data": {
    "age": true,
    "citizenship": false,
    "geo": false,
    "location": "...",
    "sanction": true,
    "mint_time_unix": ...,
    "mint_time_utc": "..."
  }
}

Fields:

Name	Type	Description
age	bool	Age verification status
citizenship	bool	Citizenship verification status
geo	bool	Geo verification status
location	string	Location
sanction	bool	Sanction verification status
mint_time_unix	int	Unix timestamp of the mint time (KYC finish time)
mint_time_utc	string	UTC time of the mint time (KYC finish time)