Check KYC Status

API Description

Check KYC Status

HTTP Request

POST /bapi/ekyc/v2/public/ekyc/customer/check-kyc-status

Request Header

Name	Type	Mandatory	Description
X-SHA2-Signature	STRING	YES	Request Signature

Request Parameters

Name	Type	Mandatory	Description
bizEntityKey	STRING	YES	business entity key, each access entity has its own bizEntityKey
entityCustomerId	STRING	YES	customer id，that is, the user id of the access entity site
kycType	STRING	YES	kyc type，USER
brokerMainAccountId	STRING	YES	broker main account id
brokerSubAccountId	STRING	YES	broker sub account id

Response Fields

Name	Type	Mandatory	Description
code	STRING	YES	error code, 000000 is success
data	StatusVo	NO

StatusVo

Name	Type	Description
statusInfo	KycVerifyStatusInfoVo	KycVerifyStatusInfoVo
levelInfo	KycLevelInfoVo	KycLevelInfoVo
nonExisted	Boolean	If kyc verify record is existed or not, true - not existed false/null - existed

KycVerifyStatusInfoVo

Name	Type	Description
failReason	STRING	fail reason
basicStatus	STRING	INITIAL,PROCESS,REVIEW,PASS,REJECT
identityStatus	STRING	INITIAL,PROCESS,REVIEW,PASS,REJECT
faceStatus	STRING	INITIAL,PROCESS,REVIEW,PASS,REJECT,SKIP
wckStatus	STRING	INITIAL,PROCESS,REVIEW,PASS,REJECT
kycUserId	STRING	kyc user id in SAAS

KycLevelInfoVo

Name	Type	Description
currentLevel	KycLevelItemVo	Current level status
passedLevel	KycLevelItemVo	Current passing KYC status level info
kycPass	Boolean	If the current user pass the kyc

KycLevelItemVo

Name	Type	Description
levelName	STRING	kyc level name INTERMEDIATE
kycStatus	STRING	PROCESS,REVIEW,REFUSED,PASS,DISABLE
kycLevelSubStatus	STRING	WCK_REJECT,HIGH_RISK

Request Body Example

{
    "bizEntityKey": "BROKERKEY",
    "entityCustomerId": "123123123123123123",
    "kycType": "USER",
    "brokerMainAccountId": "12312312",
    "brokerSubAccountId": "123123123123123123"
}

Response Example

{
    "code": "000000",
    "message": null,
    "messageDetail": null,
    "data": {
        "statusInfo": {
            "bizEntityKey": "BROKERKEY",
            "entityCustomerId": "4574117426369925632",
            "kycUserId": "4575836000526931200",
            "userType": "USER",
            "kycType": "USER",
            "businessType": null,
            "status": null,
            "expectTime": null,
            "expectTimeText": null,
            "kycStatus": "REJECT",
            "failReason": "This ID number has been used. Log in to your original account to complete the transaction.",
            "basicStatus": "PASS",
            "basicExpectTime": null,
            "basicExpectTimeText": null,
            "basicFailReason": "",
            "basicSubStatus": null,
            "documentStatus": null,
            "documentExpectTime": null,
            "documentExpectTimeText": null,
            "documentFailReason": null,
            "identityStatus": "REJECT",
            "identityExpectTime": null,
            "identityExpectTimeText": null,
            "identityFailReason": "This ID number has been used. Log in to your original account to complete the transaction.",
            "identityFailCode": null,
            "faceStatus": "REJECT",
            "faceExpectTime": null,
            "faceExpectTimeText": null,
            "faceFailReason": "This ID number has been used. Log in to your original account to complete the transaction.",
            "faceEmailStatus": null,
            "faceEmailMask": null,
            "wckStatus": "INITIAL",
            "wckExpectTime": null,
            "wckExpectTimeText": null,
            "wckFailReason": null,
            "firstName": null,
            "middleName": null,
            "lastName": null,
            "poaStatus": null,
            "poaExpectTime": null,
            "poaExpectTimeText": null,
            "poaFailReason": null,
            "eddStatus": null,
            "eddExpectTime": null,
            "eddExpectTimeText": null,
            "eddFailReason": null,
            "dbCreateTime": 1750699479373,
            "dbModifyTime": 1750699512711,
            "questionStatus": null,
            "questionFailReason": null,
            "completeTime": null,
            "basicCompleteTime": null,
            "documentCompleteTime": null,
            "identityCompleteTime": 1750699512647,
            "faceCompleteTime": 1750699512651,
            "wckCompleteTime": null,
            "poaCompleteTime": null,
            "eddCompleteTime": null,
            "questionCompleteTime": null,
            "kycSubType": null,
            "kycSubStatus": null,
            "credentialStatus": null,
            "credentialFailReason": null,
            "fiatPtStatus": null,
            "fiatPtFailReason": null,
            "memberStatus": null,
            "remediationStatus": null,
            "remediationExpectTime": null,
            "riskRateLevel": "MEDIUM",
            "riskRateScore": 31.00
        },
        "levelInfo": {
            "currentLevel": {
                "levelName": "INTERMEDIATE",
                "levelDesc": "INTERMEDIATE",
                "kycStatus": "REFUSED",
                "kycLevelSubStatus": null,
                "limit": {
                    "fiatCurrency": "USD",
                    "depositFiatDailyLimit": null,
                    "withdrawFiatDailyLimit": 20000,
                    "totalFiatDailyLimit": null,
                    "depositFiatMonthlyLimit": null,
                    "withdrawFiatMonthlyLimit": null,
                    "totalFiatMonthlyLimit": null,
                    "depositFiatYearlyLimit": null,
                    "withdrawFiatYearlyLimit": null,
                    "totalFiatYearlyLimit": null,
                    "depositFiatLifeTimeLimit": null,
                    "withdrawFiatLifeTimeLimit": null,
                    "totalFiatLifeTimeLimit": null,
                    "cryptoCurrency": "BTC",
                    "depositCryptoDailyLimit": -1,
                    "withdrawCryptoDailyLimit": 100,
                    "totalCryptoDailyLimit": null
                }
            },
            "completedLevel": null,
            "passedLevel": null,
            "definedKycPassLevel": null,
            "kycPass": false,
            "hasMultipleLevels": false,
            "passedLevels": []
        },
        "remainingSteps": null,
        "nonExisted": null,
        "oauthUserInfo": null,
        "version": 1750699512711
    },
    "success": true
}