Skip to content

API Reference


1. Info

  • Title: gRPC API
  • Version: 1.0.0
  • Description: This documentation is generated from protobuf files using protoc-gen-doc.

2. Paths

RiskService

CreatePersonalInformation

GetPersonalInformation

CreateAddressInformation

GetAddressInformation

CreateFinancialInformation

GetFinancialInformation

CreateProfessionalInvestor

GetProfessionalInvestor

CreateAgreementSignature

GetAgreementSignature

GetAgreementSignatureByName

GetKycInformation

CreateInvestmentExperience

SubmitInvestmentExperience

GetInvestmentExperience

CreateVAssetKnowledge

GetVAssetKnowledge

  • Summary: 获取虚拟资产知识评估信息
  • Method: GetVAssetKnowledge
  • Endpoint: risk.RiskService/GetVAssetKnowledge
  • Request:
  • Response:

CreateFirstTransferToHk

UpdatePersonalInformation

UpdateAddressInformation

UpdateFinancialInformation

UpdateProfessionalInvestor

UpdateKycInformation

GetAllKycInformation

GetFirstTransferToHk

GetAMLInformation

GetKYCAuditRecord

AuditKycInformation

FindAMLInformation

TravelRuleCallBack

GetEllipticReport

  • Summary: 获取Elliptic的报告
  • Method: GetEllipticReport
  • Endpoint: risk.RiskService/GetEllipticReport
  • Request:
  • Response:

GetSmallKycInformation

GetBatchSmallKycInformation

CreateCompanyInformation

CreateConnectedParty

CreateBusiness

  • Summary: CreateBusiness
  • Method: CreateBusiness
  • Endpoint: risk.RiskService/CreateBusiness
  • Request:
  • Response:

CreateFilesAttachment

CreateCustomerDeclaration

CreateCommonReportingStandard

GetCompanyInformation

GetCompanyProfessionalInvestor

GetConnectedParty

GetBusiness

  • Summary: GetBusiness
  • Method: GetBusiness
  • Endpoint: risk.RiskService/GetBusiness
  • Request:
  • Response:

GetFilesAttachment

GetCustomerDeclaration

GetCommonReportingStandard

UpdateFilesAttachment

SubmitCompanyInformation

SubmitCompanyProfessionalInvestor

AuditCompanyProfessionalInvestor

GetUserKycInformation

GetCheckKYARecord

CreateUserBank

  • Summary: 用户开户
  • Method: CreateUserBank
  • Endpoint: risk.RiskService/CreateUserBank
  • Request:
  • Response:

AddNotify

  • Summary: 添加通知
  • Method: AddNotify
  • Endpoint: risk.RiskService/AddNotify
  • Request:
  • Response:

GetNotify

  • Summary: 获取通知
  • Method: GetNotify
  • Endpoint: risk.RiskService/GetNotify
  • Request:
  • Response:

GetJobs

  • Summary: GetJobs
  • Method: GetJobs
  • Endpoint: risk.RiskService/GetJobs
  • Request:
  • Response:

AuditProfessionalInvestor

SupplementKYCInformation

GetReportData

  • Summary: 查询补充的KYA/KYT报告数据
  • Method: GetReportData
  • Endpoint: risk.RiskService/GetReportData
  • Request:
  • Response:

3. Components

3.1 Schemas

AddNotifyRequest

FieldTypeDescription
emailsstringnone
notifyTypestring字段为空则是添加NOTIFY_BIND_BANK通知:NOTIFY_BIND_BANK/NOTIFY_KYC_ID

AddNotifyResponse

FieldTypeDescription

AdditionalFiles

FieldTypeDescription
creatorstringnone
fileUrlstringnone

AdditionalFilesInfo

FieldTypeDescription
creatorstringnone
fileUrlstringnone
createTimeint64none
updateTimeint64none

AuditCompanyProfessionalInvestorRequest

FieldTypeDescription
idint64none
declaredNetWorthstring资产额
remarkstringremark
auditorstring审核人
auditorRolestring审核角色
operationstring状态
additionalFilesAdditionalFiles附件

AuditCompanyProfessionalInvestorResponse

FieldTypeDescription
idint64none

AuditKycInformationRequest

FieldTypeDescription
kycIdint64kyc ID
auditorstring审核人
auditorRolestring审核角色
operationstring状态
riskAssessmentLevelstring风险等级
remarkstring备注
amlFilestringamlFile
connectedPartysAuditKycInformationRequest.ConnectedPartysnone

ConnectedPartys

FieldTypeDescription
idint64none
amlFilestringnone

AuditKycInformationResponse

FieldTypeDescription
idint64none

AuditProfessionalInvestorRequest

FieldTypeDescription
idint64none
portfolioValuestring资产额
remarkstringremark
auditorstring审核人
auditorRolestring审核角色
operationstring状态
additionalFilesAdditionalFiles附件

AuditProfessionalInvestorResponse

FieldTypeDescription
idint64none

BankCardInfo

FieldTypeDescription
bankCardNamestringnone
bankCardNumberstringnone

BaseInfo

FieldTypeDescription
idint64none
createTimeint64none
updateTimeint64none

CheckKYARecord

FieldTypeDescription
userIdstringnone
blockchainNamestringnone
addressTypestringnone
addressstringnone
approveTimestringnone
updateTimeint64none
riskLevelstringnone
reportidstringnone
idint64none

ConnectedParty

FieldTypeDescription
partyRolestring关联方角色
namestring关联方名称
idTypestring证件类型
idNostring证件号
dateOfBirthstring出生日期
placeOfIncorporationstring公司注册地
idCardFrontstring正面照片地址
idCardBackstring反面照片地址
ownershipPercentagestring持股比例
countryOfResidencestring居住地
residentialAddressstring居住地址
addressProofstring居住地址证明
baseInfoBaseInfonone
identityRiskScorestringnone
identityRiskLevelstringnone
caseIDstringnone
caseSystemIDstringnone
amlFilestringnone
connectedPartysTypestring关联方类型:取KYCVerificationType枚举值
idExpiredTimeSstring证件过期时间
firstNamestring名字
middleNamestring中间名
lastNamestring姓氏
genderstring性别
placeOfIncorporationFlagstringnone
countryOfResidenceFlagstringnone
additionalFilesAdditionalFilesInfo附加材料
isPermanentstringnone

CreateAddressInformationRequest

FieldTypeDescription
userIdstring用户id
addressstring地址
proofMaterialsstring证明材料
additionalFilesstring附加材料
permanentAddressstringnone
placeOfBirthstringnone

CreateAddressInformationResponse

FieldTypeDescription
idint64记录id

CreateAgreementSignatureRequest

FieldTypeDescription
userIdstring用户 ID
signaturestring签名
signatureAgreedstring签名同意值(见 approved_status)
signatureTypestring签名类型:SIGN_CORPORATE/SIGN_INSTITUTIONAL

CreateAgreementSignatureResponse

FieldTypeDescription
idint64记录id

CreateBusinessRequest

FieldTypeDescription
userIdstring用户ID
industrystring业务性质(子行业)
businessCommencementDatestring业务开始日期
keyCustomerTypesstring核心客户
majorJurisdictionsstring主要收入来源地
numberOfEmployeesstring员工人数
reasonNoEmployeesstring业务开始原因
netAssetValuestring净资产
profitAfterTaxstring税后利润
yearsOfExperiencestring业务年限
averageAnnualRevenuestring平均年收入
sourceOfFundstring资金来源
sourcePfWealthstring财富来源
businessInSanctionedJurisdictionsstring是否有业务在任何被监管的地区
materialBusinessChangesstring业务变化
materialBusinessChangesDetailsstring业务变化详情
professionalInvestorStatusstring是否从事专业投资
majorBusinessActivitystringChapter 571D
accountPurposestring账户用途
investmentObjectivesstring投资目标
expectedTradingFrequencystring预期交易频率
expectedTradeVolumestring预期交易量
expectedAverageTransactionSizestring预期平均交易量
countryOfIPAddressstringIP地址所在国家
mainBankNamestring主要银行名称
bankAccountJurisdictionstring银行账户所在地
crossBorderRelationshipReasonstring跨境关系原因
industryMainstring业务性质(主行业)

CreateBusinessResponse

FieldTypeDescription
idint64记录id

CreateCommonReportingStandardRequest

FieldTypeDescription
userIdstring用户ID
typeOfEntrystring业务性质
typeOfEntryIndexstring序号
typeOfEntryRemarkstring备注 (使用 repeated 字段来表示多个备注)
jurisdictionOfResidencestring居住地
tinstringTIN (纳税人识别号)
tinUnavailabilityReasonstringTIN不可用原因
tinUnavailabilityReasonIndexstringTIN不可用原因序号
informationDeclarationstring信息声明
acknowledgementOfInformationUsestring信息使用确认
authorizedSignerCertificationstring授权签名人认证
changeInCircumstancesUndertakingstring变更情况

CreateCommonReportingStandardResponse

FieldTypeDescription
idint64none

CreateCompanyInformationRequest

企业KYC认证

FieldTypeDescription
userIdstring用户ID
companyEnglishNamestring公司名称 (英文)
companyChineseNamestring公司名称 (中文)
aliasesstring公司别名
countryOfIncorporationstring公司注册地
registrationDatestring公司注册时间
certificateNumberstring公司注册号
registrationNumberstring公司营业执照号
officeTelephoneNumberstring公司办公电话
emailstring公司邮箱
companyWebsitestring公司网站
registeredAddressstring公司注册地址
operatingAddressstring公司类型
trustNamestring信任方名称
trustGoverningLawstring信任方法律依据
trustIdentificationNumberstring信任方识别号
trustEstablishedDatestring信任方成立时间
trustTypestring信任方类型
legalFullNamestring信任方法人全名
trustAliasesstring信任方别名
trustDateOfBirthstring信任方法人出生日期
trustNationalitystring信任方法人国籍
trustGenderstring信任方法人性别
trustDocumentTypestring信任方法人证件类型
idPassportNumberstring信任方法人证件号
issuanceCountryRegionstring信任方法人证件签发国家
idExpiryDatestring信任方法人证件有效期
idCardFrontstring信任方法人证件正面
idCardBackstring信任方法人证件反面
emailAddressstring信任方法人邮箱
telephoneNumberstring信任方法人电话
residentialAddressstring信任方法人地址
addressProofstring信任方法人地址证明
permanentAddressstring信任方法人永久居住地址
typeOfPartnershipstring公司类型
nameOfAssociationstring关联方名称
membershipNumberstring关联方编号
investorsTypestringINSTITUTIONAL/CORPORATE

CreateCompanyInformationResponse

FieldTypeDescription
idint64记录id

CreateConnectedPartyRequest

FieldTypeDescription
userIdstring用户ID
userPartyInfoCreateConnectedPartyRequest.UserPartyInfonone

UserPartyInfo

用户关联方信息

FieldTypeDescription
partyRolestring关联方角色
namestring关联方名称
idTypestring证件类型
idNostring证件号
dateOfBirthstring出生日期
placeOfIncorporationstring公司注册地
idCardFrontstring正面照片地址
idCardBackstring反面照片地址
ownershipPercentagestring持股比例
countryOfResidencestring居住地
residentialAddressstring居住地址
addressProofstring居住地址证明
connectedPartysTypestring关联方类型:取KYCVerificationType枚举值
idExpiredTimeSstring证件过期时间
firstNamestring名字
middleNamestring中间名
lastNamestring姓氏
genderstring性别
placeOfIncorporationFlagstringnone
countryOfResidenceFlagstringnone
additionalFilesstring附加材料(可选)
isPermanentstring是否永久证件:YES/NO

CreateConnectedPartyResponse

FieldTypeDescription
idint64记录id

CreateCustomerDeclarationRequest

FieldTypeDescription
userIdstring用户ID
ultimateOwnershipControlDeclarationstring最终所有权控制声明
nonUSPersonDeclarationstring非美国人声明
changeNotificationAgreementstring变更通知协议
relativeOfHKbitEXAssociatesDeclarationstring与香港BitEX关联方声明
companyInstitutionAndPersonP1string公司机构和个人P1
fullNameEnglishP1string全名(英文) P1
relationshipP1string关系P1
relativeOfListedCompanyManagementDeclarationstring与上市公司管理层声明
companyInstitutionAndPersonP2string公司机构和个人P2
fullNameEnglishP2string全名(英文) P2
relationshipP2string关系P2
licensedPersonOrEmployeeOfSFCInstitutionDeclarationstring受许可的人或SFC机构雇员声明
companyInstitutionAndPersonP3string公司机构和个人P3
fullNameEnglishP3string全名(英文) P3
relationshipP3string关系P3
personNameP2stringnone
personNameP3stringnone

CreateCustomerDeclarationResponse

FieldTypeDescription
idint64记录id

CreateFilesAttachmentRequest

FieldTypeDescription
userIdstring用户ID
fundDocumentsstring基金文件
fundRegulationEvidencestring基金监管证据
fundManagerRegulationStatusstring基金经理监管状态
fundAdministratorRegulationEvidencestring基金管理者监管证据
sourceOfInvestmentFundsstring投资基金来源
fundAMLPolicystring基金AML政策
additionalFilesstring附加材料
isFundstringnone
file1stringnone
file2stringnone
file3stringnone
file4stringnone
file5stringnone
file6stringnone
file7stringnone
file8stringnone

CreateFilesAttachmentResponse

FieldTypeDescription
idint64记录id

CreateFinancialInformationRequest

FieldTypeDescription
userIdstring用户 ID
employmentStatusstring就业状态
employmentNaturestring就业性质
occupationMainstring行业一级目录
occupationSubstring行业子目录
fundsOfIncomestring资金来源(多选,用逗号隔开)
sourceOfIncomestring收入来源(多选,用逗号隔开)
isUsastring是否是美国人
additionalFilesstring附加材料
companyNamestring公司名称
companyWebsitestring公司网站
annualIncomestring年收入
tinInfosTinInfos附加TIN

CreateFinancialInformationResponse

FieldTypeDescription
idint64记录id

CreateFirstTransferToHkRequest

FieldTypeDescription
userIdstring用户 ID
amountstring转账金额
assetstring转账资产
transferTimeint64转账时间
transferTypestring转账方式
transferFromstring转账出方
transferTostring转账入方

CreateFirstTransferToHkResponse

FieldTypeDescription
idint64none

CreateInvestmentExperienceRequest

FieldTypeDescription
userIdstring用户 ID
qaDatasQaData问题与答案
agreeToTermsstring是否同意

CreateInvestmentExperienceResponse

FieldTypeDescription
riskScorefloat风险分数
riskTolerancestring风险承受等级
investmentObjectivestring投资目标
idint64id
cryptoKnowledgestringnone

CreatePersonalInformationRequest

FieldTypeDescription
userIdstring个人信息所属用户的唯一标识符。
firstNamestring个人的名字。
middleNamestring个人的中间名(可选)。
lastNamestring个人的姓氏。
genderstring个人的性别。
nationalitystring个人的国籍。
contactInformationstring个人的联系信息。
dateOfBirthstring个人的出生地。 string placeOfBirth = 8[(validate.rules).string.min_len = 1]; 个人的出生日期。
idTypestring个人所持证件的类型。
idNostring个人所持证件的编号。
idExpiredTimeSstring个人所持证件的过期时间。
idCardFrontstring个人证件的正面照片地址。
idCardBackstring个人证件的反面照片地址。
associatedAccountHkbitexstring个人与 HKbitex 账户的关联情况。
additionalFilesstring附加材料(可选)
foreignNamestring别名
placeOfIssuancestring签发地
nationalityFlagstringnone
isAssociatedAccountHKbitexstringnone
associatedAccountIDstringnone
isPermanentstring是否永久证件:YES/NO

CreatePersonalInformationResponse

FieldTypeDescription
idint64记录id

CreateProfessionalInvestorRequest

FieldTypeDescription
userIdstring用户 ID
portfolioValueAgreedstring投资组合同意值(见 approved_status)
portfolioValuestring总净值
assetstring资产单位(USDT)
assetProofstring资产证明
agreeToAllstring是否同意全部(见 approved_status)
additionalFilesstring附加材料
isUpgradestring是否升级
otherVATPHoldingsstring是否在其他虚拟资产交易平台持有资产(是/否)
otherVATPUSDValuestring在其他虚拟资产交易平台持有的等值美元金额

CreateProfessionalInvestorResponse

FieldTypeDescription
idint64记录id

CreateUserBankRequest

FieldTypeDescription
userIdstringnone
bankCardNostringnone

CreateUserBankResponse

FieldTypeDescription
walletIdint64none
userIdstringnone

CreateVAssetKnowledgeRequest

FieldTypeDescription
userIdstring用户 ID
qaDatasQaData问题与答案

CreateVAssetKnowledgeResponse

FieldTypeDescription
idint64记录id

Declaration

FieldTypeDescription
inHouseTreasuryFunctionDeclarationstring公司内部资金池功能声明
designatedInvestmentCommitteeDeclarationstring指定投资委员会声明
externalInvestmentAdvisoryTeamDeclarationstring外部投资顾问团队声明
relatedCorporationInvestmentStrategiesDeclarationstring相关企业投资策略声明
clientOwnershipAndInvestmentManagementDeclarationstring客户持股和投资管理声明
degreeAccountingBusinessstring会计业务资质声明
intlProfessionalQualificationsstring国际专业资格
sfcLicenseNostringSFC证书编号
hksiExamPaper2PassstringHKSI考试试卷2通过
hksiExamPapers1and3PassstringHKSI考试试卷1和3通过
hksiExamPapers7and8PassstringHKSI考试试卷7和8通过
hksiExamPapers1and2PassstringHKSI考试试卷1和2通过
hksiProfDipModules1To7PassstringHKSI专业资格模块1-7通过
hksiProfDipModules4and5PassstringHKSI专业资格模块4和5通过
hkceePassesInEngMathstringHKCEE英语数学通过
jobRolestring工作职责
functionsstring职能
marketstring市场
trainingCoursesstring培训课程
trainingCourseNamestring培训课程名称
trainingInstitutionNamestring培训机构名称
yearOfAttendancestring年份
productTypeIndexstring产品类型
productTypeRemarkstring产品类型备注

FindAMLInformationRequest

FieldTypeDescription
kycIdint64none
connectedPartyIdint64none

FindAMLInformationResponse

FieldTypeDescription
kycIdint64none

GetAMLInformationRequest

FieldTypeDescription
userIdstringnone

GetAMLInformationResponse

FieldTypeDescription
userIdstringnone
caseIdstringnone
amlFilestringnone
nationalityRiskstringnone
nationalitystringnone
industryRiskstringnone
industrystringnone
baseInfoBaseInfonone
kycIdint64none
identityRiskScorestring身份风险
identityRiskLevelstring身份风险等级
industryScorestring是否有同名制裁 string sameNameSanction = 12; // 是否存在负面信息 string negativeInfoExists = 13; 行业分数
nationalityScorestring国家分数
deliveryRiskstringnone
deliveryRiskScorestringnone
productRiskstringnone
productRiskScorestringnone
productRiskLevelstringnone
deliveryRiskLevelstringnone
scorestring总分数
categoriesstringnone

GetAddressInformationRequest

FieldTypeDescription
userIdstring个人信息所属用户的唯一标识符。

GetAddressInformationResponse

FieldTypeDescription
userIdstring用户id
addressstring地址
proofMaterialsstring证明材料
auditStatusstring审核信息状态
additionalFilesAdditionalFilesInfo附加材料
baseInfoBaseInfonone
kycIdint64kycId
permanentAddressstringnone
placeOfBirthstringnone

GetAgreementSignatureByNameRequest

FieldTypeDescription
userNamestring用户名

GetAgreementSignatureByNameResponse

FieldTypeDescription
listGetAgreementSignatureResponsenone

GetAgreementSignatureRequest

FieldTypeDescription
userIdstring个人信息所属用户的唯一标识符。

GetAgreementSignatureResponse

FieldTypeDescription
userIdstring用户 ID
signaturestring签名
signatureAgreedstring签名同意值(见 approved_status)
auditStatusstringnone
baseInfoBaseInfonone
kycIdint64none
sameNamestringYes/No
signatureTypestring签名类型:SIGN_CORPORATE/SIGN_INSTITUTIONAL

GetAllKycInformationRequest

FieldTypeDescription
kycIdint64none

GetAllKycInformationResponse

FieldTypeDescription
kycInfoKycInformationkyc信息
personalInfoGetPersonalInformationResponse个人信息
addressInfoGetAddressInformationResponse地址信息
financialInfoGetFinancialInformationResponse财务信息
professionalInvestorGetProfessionalInvestorResponse签名信息
agreementSignatureGetAgreementSignatureResponsenone
investmentExperienceGetInvestmentExperienceResponse专业投资者测试
vassetKnowledgeGetVAssetKnowledgeResponse问答
userInfoGetAllKycInformationResponse.UserInfo用户信息
amlInfoGetAMLInformationResponseAML信息
trasferInfoGetFirstTransferToHkResponse首次转账
kycAuditStageKycAuditStagenone
companyInfoGetCompanyInformationResponse公司信息
companyProfessionalInvestorGetCompanyProfessionalInvestorResponsenone
connectedPartyGetConnectedPartyResponsenone
filesAttachmentGetFilesAttachmentResponsenone
customerDeclarationGetCustomerDeclarationResponsenone
commonReportingStandardGetCommonReportingStandardResponsenone
businessGetBusinessResponsenone
bankCardInfoBankCardInfonone

UserInfo

FieldTypeDescription
emailstringnone
userIdstringnone

GetBatchSmallKycInformationRequest

FieldTypeDescription
userIdsstringnone

GetBatchSmallKycInformationResponse

FieldTypeDescription
listGetSmallKycInformationResponsenone

GetBusinessRequest

FieldTypeDescription
userIdstringnone

GetBusinessResponse

FieldTypeDescription
userIdstring用户id
kycIdint64KYC ID
industrystring业务性质(子行业)
businessCommencementDatestring业务开始日期
keyCustomerTypesstring核心客户
majorJurisdictionsstring主要收入来源地
numberOfEmployeesstring员工人数
reasonNoEmployeesstring业务开始原因
netAssetValuestring净资产
profitAfterTaxstring税后利润
yearsOfExperiencestring业务年限
averageAnnualRevenuestring平均年收入
sourceOfFundstring资金来源
sourcePfWealthstring资金来源
businessInSanctionedJurisdictionsstring是否有业务在任何被监管的地区
materialBusinessChangesstring业务变化
materialBusinessChangesDetailsstring业务变化详情
professionalInvestorStatusstring是否从事专业投资
majorBusinessActivitystringChapter 571D
accountPurposestring账户用途
investmentObjectivesstring投资目标
expectedTradingFrequencystring预期交易频率
expectedTradeVolumestring预期交易量
expectedAverageTransactionSizestring预期平均交易量
countryOfIPAddressstringIP地址所在国家
mainBankNamestring主要银行名称
bankAccountJurisdictionstring银行账户所在地
crossBorderRelationshipReasonstring跨境关系原因
baseInfoBaseInfonone
industryMainstring业务性质(主行业)

GetCheckKYARecordRequest

FieldTypeDescription
pageNumint32none
pageSizeint32none
startTimeint64none
endTimeint64none
blockchainNamestringnone
searchValstringnone

GetCheckKYARecordResponse

FieldTypeDescription
listCheckKYARecordnone
totalsint64none

GetCommonReportingStandardRequest

FieldTypeDescription
userIdstringnone

GetCommonReportingStandardResponse

FieldTypeDescription
userIdstring用户id
kycIdint64KYC ID
typeOfEntrystring业务性质
typeOfEntryIndexstring序号
typeOfEntryRemarkstring备注
jurisdictionOfResidencestring居住地
tinstringTIN
tinUnavailabilityReasonstringTIN不可用原因
tinUnavailabilityReasonIndexstringTIN不可用原因
informationDeclarationstring信息声明
acknowledgementOfInformationUsestring信息使用确认
authorizedSignerCertificationstring授权签名人认证
changeInCircumstancesUndertakingstring变更情况
baseInfoBaseInfonone

GetCompanyInformationRequest

FieldTypeDescription
userIdstringnone

GetCompanyInformationResponse

FieldTypeDescription
userIdstring用户ID
companyEnglishNamestring公司名称 (英文)
companyChineseNamestring公司名称 (中文)
aliasesstring公司别名
countryOfIncorporationstring公司注册地
registrationDatestring公司注册时间
certificateNumberstring公司注册号
registrationNumberstring公司营业执照号
officeTelephoneNumberstring公司办公电话
emailstring公司邮箱
companyWebsitestring公司网站
registeredAddressstring公司注册地址
operatingAddressstring公司类型
trustNamestring信任方名称
trustGoverningLawstring信任方法律依据
trustIdentificationNumberstring信任方识别号
trustEstablishedDatestring信任方成立时间
trustTypestring信任方类型
legalFullNamestring信任方法人全名
trustAliasesstring信任方别名
trustDateOfBirthstring信任方法人出生日期
trustNationalitystring信任方法人国籍
trustGenderstring信任方法人性别
trustDocumentTypestring信任方法人证件类型
idPassportNumberstring信任方法人证件号
issuanceCountryRegionstring信任方法人证件签发国家
idExpiryDatestring信任方法人证件有效期
idCardFrontstring信任方法人证件正面
idCardBackstring信任方法人证件反面
emailAddressstring信任方法人邮箱
telephoneNumberstring信任方法人电话
residentialAddressstring信任方法人地址
addressProofstring信任方法人地址证明
permanentAddressstring信任方法人永久居住地址
typeOfPartnershipstring公司类型
nameOfAssociationstring关联方名称
membershipNumberstring关联方编号
kycIdint64KYC ID
baseInfoBaseInfo基础信息
investorsTypestring信托名称

GetCompanyProfessionalInvestorRequest

FieldTypeDescription
userIdstringnone

GetCompanyProfessionalInvestorResponse

FieldTypeDescription
userIdstring用户ID
declaredNetWorthstring净资产
positionLimitstring持仓限制
publicFilingWithin12Monthsstring最近12个月内公示
representativeExpertiseDocumentsstring代表专家的专业文件
riskAwarenessDocumentsstring风险意识文件
agreementConfirmationCheckboxstring同意协议复选框
investBackgroundInvestBackgroundnone
relevantWorkRelevantWorknone
declarationDeclarationnone
baseInfoBaseInfonone
remarkstringnone
assetstringnone
portfolioValueUSDstringnone
assetUSDstringnone
auditStatusstringnone
professionalInvestorsTypestringnone
lastAuditorstringnone
lastAuditRolestringnone
additionalFilesAdditionalFilesInfonone
userTypestringnone
isUpgradestringnone
otherVATPHoldingsstringnone
otherVATPUSDValuestringnone

GetConnectedPartyRequest

FieldTypeDescription
userIdstringnone

GetConnectedPartyResponse

FieldTypeDescription
userIdstring用户id
kycIdint64KYC ID
connectedPartysConnectedPartynone

GetCustomerDeclarationRequest

FieldTypeDescription
userIdstringnone

GetCustomerDeclarationResponse

FieldTypeDescription
userIdstring用户id
kycIdint64KYC ID
ultimateOwnershipControlDeclarationstring最终所有权控制声明
nonUSPersonDeclarationstring非美国人声明
changeNotificationAgreementstring变更通知协议
relativeOfHKbitEXAssociatesDeclarationstring与香港BitEX关联方声明
companyInstitutionAndPersonP1string公司机构和个人P1
fullNameEnglishP1string全名(英文)
relationshipP1string关系P1
relativeOfListedCompanyManagementDeclarationstring与上市公司管理层声明
companyInstitutionAndPersonP2string公司机构和个人P2
fullNameEnglishP2string全名(英文)
relationshipP2string关系P2
licensedPersonOrEmployeeOfSFCInstitutionDeclarationstring受许可的人或SFC机构雇员声明
companyInstitutionAndPersonP3string公司机构和个人P3
fullNameEnglishP3string全名(英文)
relationshipP3string关系P3
baseInfoBaseInfonone
personNameP2stringnone
personNameP3stringnone

GetEllipticReportRequest

FieldTypeDescription
reportIdstringnone

GetEllipticReportResponse

FieldTypeDescription
reportIdstringnone
hashstringnone
typestringnone
sourcestringnone
fullTextstringnone
riskScorefloatnone
updatedAtint64none

GetFilesAttachmentRequest

FieldTypeDescription
userIdstringnone

GetFilesAttachmentResponse

FieldTypeDescription
userIdstring用户id
kycIdint64KYC ID
fundDocumentsstring基金文件
fundRegulationEvidencestring基金监管证据
fundManagerRegulationStatusstring基金经理监管状态
fundAdministratorRegulationEvidencestring基金管理者监管证据
sourceOfInvestmentFundsstring投资基金来源
fundAMLPolicystring基金AML政策
baseInfoBaseInfonone
additionalFilesAdditionalFilesInfonone
isFundstringnone
file1stringnone
file2stringnone
file3stringnone
file4stringnone
file5stringnone
file6stringnone
file7stringnone
file8stringnone

GetFinancialInformationRequest

FieldTypeDescription
userIdstring个人信息所属用户的唯一标识符。

GetFinancialInformationResponse

FieldTypeDescription
userIdstring用户 ID
employmentStatusstring就业状态
employmentNaturestring就业性质
occupationMainstring行业一级目录
occupationSubstring行业子目录
fundsOfIncomestring资金来源(多选,用逗号隔开)
sourceOfIncomestring收入来源(多选,用逗号隔开)
isUsastring是否是美国人
auditStatusstring审核信息状态
additionalFilesAdditionalFilesInfo附加材料
baseInfoBaseInfonone
kycIdint64kycId
companyNamestring公司名称
companyWebsitestring公司网站
annualIncomestring年收入
tinInfosTinInfosnone

GetFirstTransferToHkRequest

FieldTypeDescription
userIdstring用户 ID

GetFirstTransferToHkResponse

FieldTypeDescription
userIdstring用户 ID
amountstring转账金额
assetstring转账资产
transferTimeint64转账时间
transferTypestring转账方式
transferFromstring转账出方
transferTostring转账入方
baseInfoBaseInfonone

GetInvestmentExperienceRequest

FieldTypeDescription
userIdstring用户 ID

GetInvestmentExperienceResponse

FieldTypeDescription
userIdstringnone
riskScorefloatnone
riskToleranceLevelstringnone
investmentObjectivestringnone
expirationTimeSstringnone
cryptoKnowledgestringnone
agreeToTermsstringnone
acknowledgementStatementstringnone
riskQuestionnaireConfirmationstringnone
changeOfCircumstancesDeclarationstringnone
auditStatusstringnone
baseInfoBaseInfonone
qaDataQaDatanone

GetJobsRequest

FieldTypeDescription
requestIdsstringnone
jobTypestringKYA/KYT/TravelRule

GetJobsResponse

FieldTypeDescription
resultGetJobsResponse.ResultEntrynone

Jobs

FieldTypeDescription
resultstringlevel/result
idstringreportid/caseId

ResultEntry

FieldTypeDescription
keystringnone
valueGetJobsResponse.Jobsnone

GetKYCAuditRecordRequest

FieldTypeDescription
userIdstring用户 ID
pageNumint32none
pageSizeint32none
recordTypestringAUDIT_KYC/AUDIT_PROFESSIONAL/AUDIT_INSTITUTIONAL_PI

GetKYCAuditRecordResponse

FieldTypeDescription
listKYCAuditRecordnone
totalsint64none

GetKycInformationRequest

FieldTypeDescription
userIdstring用户 ID

GetKycInformationResponse

FieldTypeDescription
kycInfoKycInformationnone
auditStatusGetKycInformationResponse.AuditStatusnone
ieInfoGetInvestmentExperienceResponsenone
personalInfoGetPersonalInformationResponsenone
addressInfoGetAddressInformationResponsenone
companyInfoGetCompanyInformationResponsenone
companyProfessionalInvestorGetCompanyProfessionalInvestorResponsenone
otherInfoGetKycInformationResponse.OtherInfonone
professionalInvestorGetProfessionalInvestorResponsenone

AuditStatus

FieldTypeDescription
personalStatusstringnone
addressStatusstringnone
financialStatusstringnone
professionalInvestorsstringnone
agreementSignaturesstringnone
investmentExperiencestringnone
vassetKnowledgestringnone
transferToHkstringnone
companyInvestorsStatusstringnone

OtherInfo

FieldTypeDescription
portfolioValuestring持仓名义价值
assetstring资产单位

GetNotifyRequest

FieldTypeDescription
notifyTypestring字段为空则是查询NOTIFY_BIND_BANK通知:NOTIFY_BIND_BANK/NOTIFY_KYC_ID

GetNotifyResponse

FieldTypeDescription
emailsstringnone

GetPersonalInformationRequest

FieldTypeDescription
userIdstring个人信息所属用户的唯一标识符。

GetPersonalInformationResponse

FieldTypeDescription
userIdstring用户id
firstNamestring名字
middleNamestring中间名
lastNamestring姓氏
genderstring性别
nationalitystring国籍
contactInformationstring联系信息
dateOfBirthstring出生地 string placeOfBirth = 8; 出生日期
idTypestring证件类型
idNostringID号
idExpiredTimeSstring过期时间
idCardFrontstring正面照片地址
idCardBackstring反面照片地址
associatedAccountHkbitexstring关联HKbitex账户
auditStatusstring审核信息状态
additionalFilesAdditionalFilesInfo附加材料
baseInfoBaseInfonone
kycIdint64kycId
foreignNamestring别名
placeOfIssuancestringnone
nationalityFlagstringnone
isAssociatedAccountHKbitexstringnone
associatedAccountIDstringnone
isPermanentstringnone

GetProfessionalInvestorRequest

FieldTypeDescription
userIdstring个人信息所属用户的唯一标识符。

GetProfessionalInvestorResponse

FieldTypeDescription
userIdstring用户 ID
portfolioValueAgreedstring投资组合同意
portfolioValuestring总净值
assetstring资产单位(USDT)
assetProofstring资产证明
agreeToAllstring是否同意全部(见
auditStatusstring审核信息状态
additionalFilesAdditionalFilesInfonone
baseInfoBaseInfonone
remarkstringnone
kycIdint64none
portfolioValueUSDstringnone
assetUSDstringnone
lastAuditorstringnone
lastAuditRolestringnone
userTypestringnone
isUpgradestringnone
otherVATPHoldingsstringnone
otherVATPUSDValuestringnone

GetReportDataRequest

FieldTypeDescription
reportIdstringnone

GetReportDataResponse

FieldTypeDescription
reportIdstringnone
reportDatastringnone

GetSmallKycInformationRequest

FieldTypeDescription
userIdstring个人信息所属用户的唯一标识符。

GetSmallKycInformationResponse

FieldTypeDescription
statusstring见KYCStatus 申报可交易金额 = (portfolioValueUSD-otherVATPUSDValue) * 0.3 (或0.15:零售)
portfolioValuestringnone
portfolioValueAssetstringnone
userIdstringnone
portfolioValueUSDstringnone
portfolioValueAssetUSDstringnone
auditStatusstringnone
usernamestringnone
userTypestringnone
otherVATPHoldingsstring是否在其他虚拟资产交易平台持有资产(YES/NO),若为空则视为NO
otherVATPUSDValuestring在其他虚拟资产交易平台持有的等值美元金额(若为空则视为0)

GetUserKycInformationRequest

FieldTypeDescription
userIdstringnone

GetUserKycInformationResponse

FieldTypeDescription
kycInfoKycInformationkyc信息
personalInfoGetPersonalInformationResponse个人信息
addressInfoGetAddressInformationResponse地址信息
financialInfoGetFinancialInformationResponse财务信息
professionalInvestorGetProfessionalInvestorResponse专业投资者信息
agreementSignatureGetAgreementSignatureResponse签名信息
investmentExperienceGetInvestmentExperienceResponse专业投资者测试
vassetKnowledgeGetVAssetKnowledgeResponse问答
amlInfoGetAMLInformationResponseAML信息
trasferInfoGetFirstTransferToHkResponse首次转账
companyInfoGetCompanyInformationResponse公司信息
companyProfessionalInvestorGetCompanyProfessionalInvestorResponsenone
connectedPartyGetConnectedPartyResponsenone
filesAttachmentGetFilesAttachmentResponsenone
customerDeclarationGetCustomerDeclarationResponsenone
commonReportingStandardGetCommonReportingStandardResponsenone
businessGetBusinessResponsenone

GetVAssetKnowledgeRequest

FieldTypeDescription
userIdstring用户 ID

GetVAssetKnowledgeResponse

FieldTypeDescription
userIdstringnone
scorefloatnone
auditStatusstringnone
baseInfoBaseInfonone
qaDataQaDatanone

InvestBackground

FieldTypeDescription
categorystring分类
investmentExperiencestring投资经验
marketInvolvedstring市场涉及
productNameTradedstring产品名称
transactionsPerYearstring年交易量
categoryRemarkstringnone

KYCAuditRecord

FieldTypeDescription
userIdstringnone
auditorstringnone
auditRolestringnone
operationstringnone
submitIPstringnone
ipCountrystringnone
isVPNUsedstringnone
riskLevelstringnone
remarkstringnone
baseInfoBaseInfonone
isProxystringnone
isTorstringnone
recordTypestringnone

KycAuditStage

FieldTypeDescription
userIdstringnone
kycIdint64none
auditorstringnone
auditRolestringnone
operationstringnone
remarkstringnone
baseInfoBaseInfonone

KycInformation

FieldTypeDescription
userIdstringnone
verificationTypestringnone
lastAuditorstringnone
lastAuditRolestringnone
statusstringnone
remarkstringnone
expirationTimeSstringnone
submitIPstringnone
isVPNUsedstringnone
ipCountrystringnone
riskAssessmentScorestringnone
riskAssessmentLevelstringnone
needAuditRolestringnone
baseInfoBaseInfonone
auditStatusstringnone
corporateTypestringnone
previousStatusstringnone

QaData

FieldTypeDescription
questionstring问题
answerstring答案
remarkstringnone

RelevantWork

FieldTypeDescription
jobTitlestring职位
dutiesstring职责
responsibilityLevelstring责任级别
yearsExperiencestring工作年限
lengthOfServicestring服务时长

SubmitCompanyInformationRequest

FieldTypeDescription
userIdstring用户 ID
signaturestring签名
signatureAgreedstring签名同意值(见 approved_status)
corporateTypestring公司类型
signatureTypestring签名类型:SIGN_CORPORATE/SIGN_INSTITUTIONAL

SubmitCompanyInformationResponse

FieldTypeDescription
idint64none

SubmitCompanyProfessionalInvestorRequest

FieldTypeDescription
userIdstring用户ID
declaredNetWorthstring净资产
positionLimitstring持仓限制
publicFilingWithin12Monthsstring最近12个月内公示
representativeExpertiseDocumentsstring代表专家的专业文件
riskAwarenessDocumentsstring风险意识文件
agreementConfirmationCheckboxstring同意协议复选框
investBackgroundInvestBackgroundnone
relevantWorkRelevantWorknone
declarationDeclarationnone
professionalInvestorsTypestringnone
assetstringnone
additionalFilesstring附加材料
isUpgradestring是否升级
otherVATPHoldingsstring是否在其他虚拟资产交易平台持有资产(是/否)
otherVATPUSDValuestring在其他虚拟资产交易平台持有的等值美元金额

SubmitCompanyProfessionalInvestorResponse

FieldTypeDescription
idint64记录id

SubmitInvestmentExperienceRequest

FieldTypeDescription
userIdstring用户 ID
acknowledgementStatementstringnone
riskQuestionnaireConfirmationstringnone
changeOfCircumstancesDeclarationstringnone
idint64none

SubmitInvestmentExperienceResponse

FieldTypeDescription
idint64记录id

SupplementKYCInformationRequest

FieldTypeDescription
riskFilestringnone
riskLevelstringnone
jobTypestringnone
requestIdstringnone

SupplementKYCInformationResponse

FieldTypeDescription
riskLevelstringnone
riskReportIdstringnone
isExistbool报告是否存在

TinInfos

FieldTypeDescription
jurisdictionOfResidencestringnone
tinNostringnone
tinReasonIndexstringnone
tinReasonstringnone

TravelRuleCallBackRequest

FieldTypeDescription
reqBodybytesnone

TravelRuleCallBackResponse

FieldTypeDescription

UpdateAddressInformationRequest

FieldTypeDescription
idint64none
auditStatusstringQualified/NotQualified
additionalFilesAdditionalFiles附加材料(可选)

UpdateAddressInformationResponse

FieldTypeDescription
idint64none

UpdateFilesAttachmentRequest

FieldTypeDescription
idint64none
additionalFilesAdditionalFiles附加材料(可选)

UpdateFilesAttachmentResponse

FieldTypeDescription
idint64none

UpdateFinancialInformationRequest

FieldTypeDescription
idint64none
auditStatusstringQualified/NotQualified
additionalFilesAdditionalFiles附加材料(可选)

UpdateFinancialInformationResponse

FieldTypeDescription
idint64none

UpdateKycInformationRequest

FieldTypeDescription
kycIdint64none
operationstringnone
remarkstringnone
auditorstringnone
auditRolestringnone
riskAssessmentLevelstringkyc风险等级

UpdateKycInformationResponse

FieldTypeDescription
kycIdint64none

UpdatePersonalInformationRequest

FieldTypeDescription
idint64none
auditStatusstringQualified/NotQualified
additionalFilesAdditionalFiles附加材料(可选)

UpdatePersonalInformationResponse

FieldTypeDescription
idint64none

UpdateProfessionalInvestorRequest

FieldTypeDescription
idint64none
auditStatusstringQualified/NotQualified
additionalFilesAdditionalFiles附加材料(可选)
portfolioValuestring资产额
remarkstringremark

UpdateProfessionalInvestorResponse

FieldTypeDescription
idint64none

3.2 Enums

ApprovedStatus

NameNumberDescription
NONE_APPROVED_STATUS0none
YES1none
NO2none

AuditType

NameNumberDescription
AUDIT_TYPE_UNSPECIFIED0none
AUDIT_KYC1none
AUDIT_PROFESSIONAL2none
AUDIT_INSTITUTIONAL_PI3none

CorporateType

NameNumberDescription
COMPANY_TYPE_UNSPECIFIED0none
LIMITED1none
PARTNERSHIP2none
TRUSTED3none

KYCAuditStage

NameNumberDescription
NONE_KYC_AUDIT_STAGE0未定义
INITIAL_REVIEW1初级审核
OPERATION_REVIEW2运营审核
COMPLIANCE_REVIEW3合规审核
RO_REVIEW4RO审核

KYCAuditStatus

KYC审核枚举

NameNumberDescription
NONE_KYC_AUDIT_STATUS0未定义
QUALIFIED1合格
NOTQUALIFIED2不合格

KYCGender

NameNumberDescription
NONE_KYC_GENDER0none
MALE1none
FEMALE2none

KYCIDType

NameNumberDescription
NONE_KYC_ID_TYPE0none
IDENTIFY_CARD1none
PASSPORT2none

KYCOperation

NameNumberDescription
NONE_KYC_OPERATION0none
KYC_SUBMIT1提交
KYC_NEED_UPDATE2需要更新
KYC_EXPIRED3失效
KYC_RESTORE4恢复
KYC_INITIAL_APPROVED5初级审核通过
KYC_INITIAL_REJECTED6初级审核拒绝
KYC_INITIAL_PERMANENTLY_REJECTED7初级审核永久拒绝
KYC_OPERATION_APPROVED8运营审核通过
KYC_OPERATION_REJECTED9运营审核拒绝
KYC_OPERATION_PERMANENTLY_REJECTED10运营审核永久拒绝
KYC_OPERATION_TRANSFERRED_TO_COMPLIANCE11运营审核移交合规
KYC_COMPLIANCE_APPROVED12合规审核通过
KYC_COMPLIANCE_REJECTED13合规审核拒绝
KYC_COMPLIANCE_PERMANENTLY_REJECTED14合规审核永久拒绝
KYC_RO_APPROVED15RO审核通过
KYC_RO_REJECTED16RO审核拒绝
KYC_RO_PERMANENTLY_REJECTED17RO审核永久拒绝
KYC_RE_SUBMIT18重新提交
KYC_SUBMIT_RISK_ASSESSMENT19提交风险测评
KYC_UPDATE_RISK_SCORE20更新风险分数
KYC_SUBMIT_KNOWLEDGE21提交知识问答

KYCSignatureType

NameNumberDescription
NONE_KYC_SIGNATURE_TYPE0none
SIGN_CORPORATE1Corporate
SIGN_INSTITUTIONAL2Institutional

KYCStatus

KYCStatus 枚举定义

NameNumberDescription
NONE_KYC_STATUS0未定义状态
TO_BE_SUBMITTED1待提交
TO_BE_REVIEWED2待审核
UNDER_REVIEW3审核中
EXPIRED4已失效
FAILED5审核失败
REJECTED6永久拒绝
APPROVED7审核通过
NEED_UPDATE8需要更新
COMPLETED9完成

KYCVerificationType

NameNumberDescription
NONE_KYC_VERIFICATION_TYPE0none
PERSONAL1个人
ORGANIZATION2组织

NotifyType

NameNumberDescription
NOTIFY_NONE0none
NOTIFY_BIND_BANK1none
NOTIFY_KYC_ID2none

ProfessionalInvestorsType

NameNumberDescription
PROFESSIONAL_INVESTORS_TYPE_UNSPECIFIED0none
INSTITUTIONAL1Institutional
CORPORATE2Corporate

RiskLevel

NameNumberDescription
NONE_RISK_LEVEL0none
LOW1低风险
MEDIUM2中风险
HIGH3高风险
MEDIUM_HIGH4none
MEDIUM_LOW5none
RISK_REJECTED6禁用
VERY_HIGH7none
MODERATE8none

UserTypes

NameNumberDescription
NONE_USER_TYPE0none
RETAIL1none
PI2none

4. Scalar Value Types

Proto TypeGo TypeC++ TypeJava TypePython TypeNotes
doublefloat64doubledoublefloat
floatfloat32floatfloatfloat
int32int32int32intintUses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint32 instead.
int64int64int64longint/longUses variable-length encoding. Inefficient for encoding negative numbers – if your field is likely to have negative values, use sint64 instead.
uint32uint32uint32intint/longUses variable-length encoding.
uint64uint64uint64longint/longUses variable-length encoding.
sint32int32int32intintUses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int32s.
sint64int64int64longint/longUses variable-length encoding. Signed int value. These more efficiently encode negative numbers than regular int64s.
fixed32uint32uint32intintAlways four bytes. More efficient than uint32 if values are often greater than 2^28.
fixed64uint64uint64longint/longAlways eight bytes. More efficient than uint64 if values are often greater than 2^56.
sfixed32int32int32intintAlways four bytes.
sfixed64int64int64longint/longAlways eight bytes.
boolboolboolbooleanboolean
stringstringstringStringstr/unicodeA string must always contain UTF-8 encoded or 7-bit ASCII text.
bytes[]bytestringByteStringstrMay contain any arbitrary sequence of bytes.

🚀 构建现代化数字资产交易平台