Skip to content

提交用户 KYC

POST /openapi/v1/users/kyc
内容
请求方法POST
请求路径/openapi/v1/users/kyc
请求类型application/json

请求参数

字段类型必填说明
emailstring用户邮箱,按现有接口契约使用。
namestring姓名。
birthdaystring生日,格式为 yyyy-MM-dd
documentTypestring证件类型:passportid_carddriver_license
documentNumberstring证件号码。
documentCountrystring证件签发国家/地区,两位代码,例如 HK
documentExpiryDatestring条件证件有效期,格式为 yyyy-MM-dd;与 documentPermanentlyValid 二选一。
documentPermanentlyValidboolean条件证件永久有效时传 true;与 documentExpiryDate 二选一。传 false 不等同于未传。
frontImageUrlstring证件正面图片上传后返回的 URL。
backImageUrlstring条件证件背面图片上传后返回的 URL;id_carddriver_license 必须提供,passport 可不提供。
selfieImageUrlstring身份自拍图片上传后返回的 URL。
phoneCountryCodestring手机号国家区号,例如 +852
phoneNumberstring仅数字,4 到 20 位。
genderstring性别:malefemale
annualIncomestring年收入区间:<2000020000-5000050000-200000200000-500000>500000
occupationstring职业。
positionstring职位。
nationalitystring国籍,两位国家/地区代码。
contactAddressstring联系地址。
supportingDocumentsarray条件非 HK 用户必须提供,至少 1 项,最多 10 项;HK 用户可不传。详见下表。
memberIdstring平台成员 ID,仅用于平台定位用户,不会发送给 CPlus。

supportingDocuments

字段类型必填说明
documentTypestringUTILITY_BILLTENANCY_AGREEMENTADDRESS_PROOFBANK_STATEMENTTRAVEL_PERMIT_FRONTTRAVEL_PERMIT_BACKPROOF_OF_VISIT
fileUrlstring辅助证明文件上传后返回的 URL。

有效期字段必须且只能选择一种:

  • 有有效期的证件:传 documentExpiryDate,不要传 documentPermanentlyValid
  • 永久有效的证件:传 documentPermanentlyValid: true,不要传 documentExpiryDate

两者同时传、两者都不传,或传 documentPermanentlyValid: false,都会被拒绝。

图片必须先通过现有 KYC 图片上传接口取得 URL,再提交 KYC。

请求示例

json
{
  "email": "user@example.com",
  "name": "Test User",
  "birthday": "1990-01-01",
  "documentType": "passport",
  "documentNumber": "P1234567",
  "documentCountry": "HK",
  "documentExpiryDate": "2030-12-31",
  "frontImageUrl": "https://example.com/front.jpg",
  "selfieImageUrl": "https://example.com/selfie.jpg",
  "phoneCountryCode": "+852",
  "phoneNumber": "91234567",
  "gender": "male",
  "annualIncome": "50000-200000",
  "occupation": "Engineer",
  "position": "Senior Engineer",
  "nationality": "HK",
  "contactAddress": "Hong Kong",
  "memberId": "member-123"
}

响应 data

字段类型说明
successboolean是否处理成功。
codestring平台响应码。
messagestring平台响应说明。
externalUserIdstring外部用户 ID。
kycRecordIdstringKYC 记录 ID。
statusstring/nullFuturePay 统一 KYC 主状态:PENDINGPENDING_APPROVALAPPROVEDREJECTED
subStatusstring/null外部渠道原始 KYC 子状态,值域可能扩展;当前已知值为 not_submittedpending_approvalapprovedrejected
cardAccountIdstring/null外部渠道卡账户 ID;渠道未返回时为 null