Verify zkOBS Status

Before making any API requests, please refer to the Getting Started section on the zkMe API page to obtain the necessary API access parameters.

Get Users Accredited Investor Status Overview

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

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

Request Body

{
  "mchNo": "YourAppID" ,
  "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

Chain Name

zkMe Chain ID

Aptos

aptos-1

Arbitrum

42161

Base

8453

BNB Smart Chain

BounceBit

6001

Ethereum

Kaia

8217

Manta

169

Neutron

neutron-1

Polygon

137

Ronin

2020

Solana

solana

TON

ton

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.

PreviousGet KYT Results NextVerify zkKYB Status

Last updated 1 month ago

hashtagGet Users Accredited Investor Status Overview

hashtagRequest Body

hashtagFields Explanation

hashtagSupported Chain List

hashtagFields Explanation

Get Users Accredited Investor Status Overview

Request Body

Fields Explanation

Supported Chain List

Fields Explanation