Query KYC status By EntityCustomerId

API Description

Query KYC Detail INFO Query API

HTTP Request

POST /bapi/ekyc/v2/public/ekyc/customer/query-kyc-info

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

Response Fields

Name	Type	Mandatory	Description
code	STRING	YES	error code，000000000 is success
data	KycInfoVo	NO

KycInfoVo

Name	Type	Description
statusInfo	KycVerifyStatusInfoVo
basicInfo	KycBasicInfoVo
identityInfo	KycIdentityInfoVo
riskScore	UserRiskScoreVo
levelInfo	KycLevelInfoVo	ref to check-kyc-status
wckInfo	KycWckInfoVo
questionInfo	List<QuestionInfo>	Questionnaire answer records for KZ Entity broker users. Empty if no questionnaire has been submitted
tncInfo	TncInfo	T&C sign info for KZ Entity broker users. `null` if no TNC record exists

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

KycBasicInfoVo

Name	Type	Description
firstName	STRING	First name
middleName	STRING	Middle name
lastName	STRING	Last Name
dob	STRING	Birthday, yyyy-MM-dd
residentialCountry	STRING	Country of residence
country	STRING	nationality

KycIdentityInfoVo

Name	Type	Description
bizNo	STRING	Biz no
firstName	STRING	First name
middleName	STRING	Middle name
lastName	STRING	Last name
dob	STRING	birthday yyyy-MM-dd
idCountry	STRING	Document issuing country 2-alpha code
nationalityCountry	STRING	Nationality country 2-alpha code
idType	STRING	IdentityDocumentType. for example: ID_CARD, PASSPORT, DRIVING_LICENSE,RESIDENCE_PERMIT
idSubType	STRING	id doc sub type
idNumber	STRING	id Number
idExpiry	STRING	yyyy-MM-dd
personalNumber	STRING
gender	STRING
issuingAuthority	STRING
issuingDate	STRING	yyyy-MM-dd
issuingPlace	STRING
registrationNumber	STRING
city	STRING
stateCode	STRING
postalCode	STRING
address	STRING
frontFileUrl	STRING	id front image download url
backFileUrl	STRING	id back image download url
faceFileUrl	STRING	face image download url
faceDetectFileUrl	STRING
vendorsCode	STRING	Channel code: SUMSUB_SDK,ONFIDO_SDK

UserRiskScoreVo

Name	Type	Description
riskScore	INT	Risk score
riskLevel	STRING	Risk level: LOWER,LOW,MEDIUM,HIGH,HIGHER,EXTREME
dob	STRING	birthday yyyy-MM-dd
pep	INT	Is pep
sanctionHit	INT	Is sanction hit
nationality	STRING
residenceCountry	STRING

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

KycWckInfoVo

Name	Type	Description
bizNo	STRING	Biz no
status	STRING	Status: PENDING,AUDIT_FIRST,AUTO_REJECT,AUTO_PASS,AUDIT_REJECT,AUDIT_PASS
type	STRING	Type: INDIVIDUAL
name	STRING	Check name
birthDate	STRING	yyyy-MM-dd
residenceCountry	STRING
rejectReason	STRING
completeTime	DATE

QuestionInfo

Each element in the questionInfo list represents a single questionnaire answer record submitted by the KZ Entity broker for this user. Populated after a successful share-kyc-data call with questionnaireInfo.

Name	Type	Description
flowType	STRING	Questionnaire group / version identifier (e.g. `"KZ_V6"`)
questionTitle	STRING	Question title key. Must match one of the configured question titles for the given questionnaire version
questionSubTitle	STRING	Question sub-title (if any)
questionId	LONG	Question record ID
questionType	STRING	Question risk type
answers	List<STRING>	List of selected option keys for this question
sourceType	STRING	Source type of the answer record (e.g. `IMPORT`)
dbCreateTime	DATE	Record creation time
dbModifyTime	DATE	Record last modification time

TncInfo

Returned inside KycInfoVo.tncInfo when the user has submitted T&C acceptance data.

Name	Type	Description
tncVersion	STRING	Version of the T&C document the user consented to (format: `a.b`, e.g. `"1.0"`)
consent	BOOLEAN	Whether the user explicitly consented to the Terms & Conditions
signTime	DATE	Timestamp of the user's TNC consent action
userSubmitIp	STRING	IP address of the user at the time of TNC submission
sourceType	STRING	Source type of the TNC record (e.g. `IMPORT`)
dbCreateTime	DATE	Record creation time

Request Body Example

{
    "bizEntityKey": "BROKERKEY",
    "entityCustomerId": "45712345678999212345",
    "kycType": "USER"
}

Response Example

{
    "code": "000000",
    "message": null,
    "messageDetail": null,
    "data": {
        "statusInfo": {
            "bizEntityKey": "BROKERKEY",
            "entityCustomerId": "45712345678999212345",
            "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
        },
        "basicInfo": {
            "id": 4575836001114133760,
            "bizEntityKey": "BROKERKEY",
            "bizKey": "BROKERKEY",
            "kycUserId": "4575836000526931200",
            "basicType": "USER",
            "basicStatus": "PASS",
            "basicFailReason": null,
            "auditor": null,
            "auditorTime": null,
            "firstName": "BO",
            "middleName": "testMiddleName",
            "lastName": "LI",
            "residentialCountry": "AE",
            "dob": "1986-08-14",
            "postalCode": "123456",
            "city": "bbb",
            "address": "aaa",
            "emailAddress": null,
            "authFileKey": null,
            "authFilePath": null,
            "companyName": null,
            "companyRegistrationNumber": null,
            "companyIncorporationDate": null,
            "contactMobileCode": null,
            "contactMobile": null,
            "corporateEmail": null,
            "companyRegisteredCountry": null,
            "companyRegisteredPostalCode": null,
            "companyRegisteredCity": null,
            "companyRegisteredAddress": null,
            "companyOperatingCountry": null,
            "companyOperatingPostalCode": null,
            "companyOperatingCity": null,
            "companyOperatingAddress": null,
            "sourceOfFunds": null,
            "sourceOfWealth": null,
            "submitIp": "192.168.1.1",
            "submitClient": null,
            "submitSource": null,
            "submitDevice": null,
            "dbCreateTime": 1750699479396,
            "dbModifyTime": 1750699479396,
            "gender": null,
            "country": "AE",
            "idType": null,
            "idCardNumber": null,
            "regionState": null,
            "tin": null,
            "suburb": null,
            "issuer": null,
            "countryOfIssue": null,
            "npwp": null,
            "phoneNumber": null,
            "placeOfBirth": null,
            "panId": null,
            "requestTime": 1750699479396,
            "requestIp": "192.168.1.1",
            "website": null,
            "applyReason": null,
            "memberType": null,
            "ext": null,
            "entityUserId": null
        },
        "identityInfo": {
            "bizEntityKey": "BROKERKEY",
            "bizKey": "BROKERKEY",
            "kycUserId": "4575836000526931200",
            "bizNo": "88ed88b9ec854503abfe905548211b56",
            "vendorsCode": "",
            "documentType": "ID_CARD",
            "selectCountry": "SG",
            "frontFileKey": "ae6dd72112ec41d9b74be3d965d499d8",
            "frontFilePath": "/SAAS/BROKERKEY/USER_UPLOAD/20250623/4575836000526931200_identity_front_172439955986.jpg",
            "frontFileUrl": "https://www.somepage.com",
            "backFileKey": "a0090a3067fc4dffaebed9d0fbecb341",
            "backFilePath": "/SAAS/BROKERKEY/USER_UPLOAD/20250623/4575836000526931200_identity_back_172439508427.jpeg",
            "backFileUrl": "https://www.somepage.com",
            "faceFileKey": "8c05214b836946e89fc8a10443d522d1",
            "faceFilePath": "/SAAS/BROKERKEY/USER_UPLOAD/20250623/4575836000526931200_identity_face_172439508685.jpeg",
            "faceFileUrl": "https://www.somepage.com",
            "faceDetectFileKey": null,
            "faceDetectFilePath": null,
            "faceDetectFileUrl": null,
            "applyStatus": "REJECT",
            "failReason": "This ID number has been used. Log in to your original account to complete the transaction.",
            "vendorsStatus": null,
            "vendorsReason": null,
            "auditor": null,
            "auditorTime": null,
            "completeTime": null,
            "submitIp": "192.168.1.1",
            "submitClient": null,
            "submitSource": null,
            "submitDevice": null,
            "firstName": "testFirstName",
            "middleName": "testMiddleNameboli",
            "lastName": "testLastNameLItest01",
            "dob": "1986-08-14",
            "idType": "ID_CARD",
            "idSubType": "INTERNATIONAL_PASSPORT",
            "idCountry": "AE",
            "nationalityCountry": "AE",
            "idNumber": "testSaasBrokers0144288491",
            "idExpiry": "2030-08-15",
            "idUsState": "testIdUsState",
            "personalNumber": "personalNumber6462313972",
            "gender": "M",
            "nationality": null,
            "issuingAuthority": "firstName",
            "issuingDate": "2000-08-16",
            "issuingPlace": "AE",
            "registrationNumber": "registrationNumber4039460415",
            "city": "testCity",
            "stateCode": "QWER",
            "postalCode": "123456",
            "address": "testAddressData",
            "remarks": "IMPORT",
            "language": null,
            "solarisReportPath": null,
            "solarisReportUrl": null,
            "idExpirySubStatus": null,
            "idGracePeriodRedoSubStatus": null,
            "sourceType": "IMPORT",
            "identityApplyExtraInfo": null,
            "ocrDocumentType": null
        },
        "poaInfo": null,
        "eddInfo": null,
        "eddInfos": null,
        "eddTriggersAndInfos": null,
        "questionInfo": [],
        "riskScore": {
            "id": 4575836012002463489,
            "bizEntityKey": "BROKERKEY",
            "bizKey": "BROKERKEY",
            "kycUserId": "4575836000526931200",
            "riskScore": 31,
            "riskLevel": "MEDIUM",
            "dob": "1986-08-14",
            "pep": null,
            "sanctionHit": null,
            "documentHit": null,
            "nationality": "AE",
            "residenceCountry": "AE",
            "kycLevelName": "INTERMEDIATE",
            "operator": null,
            "remark": null,
            "fiatCurrency": null,
            "depositFiatDailyLimit": null,
            "depositFiatMonthlyLimit": null,
            "depositFiatYearlyLimit": null,
            "depositFiatLifeTimeLimit": null,
            "withdrawFiatDailyLimit": null,
            "withdrawFiatMonthlyLimit": null,
            "withdrawFiatYearlyLimit": null,
            "withdrawFiatLifeTimeLimit": null,
            "riskTemplate": "DEFAULT",
            "dbCreateTime": 1750699480048,
            "dbModifyTime": 1750699480048,
            "riskScoreDetail": null,
            "adminVo": null,
            "sourceType": "NORMAL",
            "sanctionHitEternal": null,
            "adverseMediaEternal": null,
            "dryRun": false
        },
        "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": {
                "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
                }
            },
            "kycPass": false,
            "hasMultipleLevels": false,
            "passedLevels": []
        },
        "nonExisted": null,
        "wckInfo": null
    },
    "success": true
}

Query KYC status By EntityCustomerId

API Description​

HTTP Request​

Request Header​

Request Parameters​

Response Fields​

KycInfoVo​

KycVerifyStatusInfoVo​

KycBasicInfoVo​

KycIdentityInfoVo​

UserRiskScoreVo​

KycLevelInfoVo​

KycWckInfoVo​

QuestionInfo​

TncInfo​

Request Body Example​

Response Example​