zkPassport is now live — verify ePassport authenticity with zero-knowledge proofs, a trust anchor for identity in the age of AI.

⌘Ctrlk

GitHub Twitter Discord

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/getBusinessStatus

Request 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

Name

Type

Description

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.

programNo

string

Same as the programNo you pass for the SDK integration.

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

Name

Type

Description

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

Name

Type

Description

statusCode

number

Indicates the current verification status of the KYB process.

Status codes are defined as follows:

1 – Verification Started
2 – Info Submitted
3 – Under Review
4 – Resubmission Required
5 – Verification Passed
6 – Verification Failed

statusDesc

string

A readable description of the current verification stage, derived from statusCode.

PreviousVerify zkOBS Status NextSmart Contract

Last updated 1 month ago

hashtagGet Entity KYB Result Overview

hashtagRequest Body

hashtagFields Explanation

hashtagSample Response

hashtagFields Explanation

Get Entity KYB Result Overview

Request Body

Fields Explanation

Sample Response

Fields Explanation