Verify zkKYB Status
Get Entity KYB Result Overview
Returns the verification status of the user for the following credential: zkKYB - Know Your Business
POST https://agw.zk.me/kybpopup/api/kyb/getBusinessStatusRequest Body
{
"mchNo": "YourAppID" ,
"accessToken": "YourAccessToken",
// Same as the access token obtained during SDK integration.
// See: https://docs.zk.me/hub/start/onboarding/integration/js-sdk/zkkyb#access-token
"programNo": "YourProgramNo",
"externalID": "UID" // identifier for the KYB entity defined by you (e.g. company name, walletAddress, or email)
}Fields Explanation
mchNo
string
Same as AppID.
accessToken
string
The same access token obtained during SDK integration. Used to authenticate subsequent API requests. Valid for 30 minutes.
externalID
string
The unique identifier provided by you to reference the KYB entity to be verified. This should match the getExternalID() passed during SDK integration.
Sample Response
{
"code": ...,
"msg": "...",
"data": {
"statusCode": ...,
"statusDesc": "..."
},
"timestamp": ...
}Fields Explanation
code
number
Response code. 80000000 indicates success.
msg
string
Response message.
data
object
List of verifierValues objects (see data Object)
timestamp
number
Response timestamp in milliseconds.
data Object
statusCode
number
Indicates the current verification status of the KYB process.
Status codes are defined as follows:
1– Verification Started2– Info Submitted3– Under Review4– Resubmission Required5– Verification Passed6– Verification Failed
statusDesc
string
A readable description of the current verification stage, derived from statusCode.
Last updated