get
https://sandboxapi.legendtrading.com/v2/app/kyc/individual/fields
返回用户提交KYC需要完成的字段
接口详情
检查字段完成进度,获取Legend Trading要求的个人用户基本信息字段及其完成状态。
参数说明
country_iso2_code 与 uid 参数为二选一必填项,具体使用场景如下:
| 适用场景 | 参数名 | 说明 |
|---|---|---|
| 用户未开始注册 | country_iso2_code | 根据国家/地区代码,返回该地区用户需要填写的全部字段列表 |
| 用户已部分完成 KYC | uid | 根据用户唯一标识,返回该用户尚未完成的必填字段清单 |
如果两个参数都传递了,则以country_iso2_code为准,但是同时也会检查uid是否有效。
有些必填项取决于账户,而不是请求中传入的国家。
tin就是其中之一:它仅对账户区域为 EU 的个人账户必填,而账户区域无法仅凭country_iso2_code推断。因此不带uid的预览不会返回tin。账户建立后请携带uid重新查询,以获得账户级的字段清单。
返回示例(全量)
{
"request_id": "d985733777cc6c94e483a574330fa701",
"status": "success",
"code": "100000",
"message": "success",
"data": [
{
"required_fields": ["email", "ip", "citizenship_iso2_codes", "id_file", "selfie_file", "first_name", "last_name", "birthdate", "place_of_birth", "country_iso2_code", "state", "city", "address", "zipcode", "proof_of_residence_file", "questionnaire"],
"optional_fields": ["phone_isd_code", "phone_number", "id_no", "id_type", "id_doc_type", "id_doc_number", "id_verification", "middle_name", "aliases", "address_line_2", "ssn"]
}
],
"metadata": {}
}字段说明
必填/可选的划分是动态的——随用户所在国家/地区和集成流程变化(例如 ssn 仅美国居民必填、tin 仅 EU 个人账户必填、proof_of_residence_file 仅欧洲交易国家用户必填、id_verification 仅混合流程必填)。下表覆盖所有可能返回的字段:含义、必填条件,以及完成该字段所需调用的接口:
| 字段名 | 是否必填 | 说明 | 完成方式 |
|---|---|---|---|
email | 必填 | 用户邮箱地址 | POST /kyc/individual/pi |
ip | 必填 | 用户 IP 地址 | POST /kyc/individual/pi(ip_address 参数;SDK 流程自动采集) |
first_name | 必填 | 法定名 | POST /kyc/individual/pi |
last_name | 必填 | 法定姓 | POST /kyc/individual/pi |
birthdate | 必填 | 出生日期(YYYY-MM-DD),须年满 18 周岁 | POST /kyc/individual/pi |
place_of_birth | 必填(v2 用户) | 出生国家/地区,ISO 3166-1 alpha-2 代码 | POST /kyc/individual/pi |
citizenship_iso2_codes | 必填(v2 用户) | 国籍(公民身份),ISO 3166-1 alpha-2 代码 | POST /kyc/individual/pi |
country_iso2_code | 必填 | 居住国家/地区,ISO 3166-1 alpha-2 代码 | POST /kyc/individual/pi |
state | 必填 | 居住州/省(美国居民会校验州的有效性) | POST /kyc/individual/pi |
city | 必填 | 居住城市 | POST /kyc/individual/pi |
address | 必填 | 居住地址(第一行) | POST /kyc/individual/pi |
zipcode | 必填 | 邮政编码 | POST /kyc/individual/pi |
id_file | 必填(API 集成) | 身份证件影像(护照/身份证/驾照) | POST /kyc/individual/file |
selfie_file | 必填(API 集成) | 用户自拍/人像照片 | POST /kyc/individual/file |
proof_of_residence_file | 条件必填 | 地址证明文件;欧洲交易国家用户必填 | POST /kyc/individual/file/poa |
questionnaire | 必填 | KYC 调查问卷 | 先 GET /kyc/individual/qa 获取问题,再 POST /kyc/individual/qa 提交答案 |
ssn | 条件必填 | 社会安全号码;仅美国居民必填 | POST /kyc/individual/pi |
tin | 条件必填 | 税号(TIN);账户区域为 EU 的个人用户必填。每个账户只收集一次,各收集入口共用同一份数据;值本身为只写(******) | POST /kyc/individual/pi 或 POST /kyc/individual/tin |
id_verification | 条件必填 | 人脸识别/IDV 验证;混合流程必填 | POST /kyc/individual/idv 获取验证会话/链接 |
middle_name | 可选 | 中间名 | POST /kyc/individual/pi |
aliases | 可选 | 别名/曾用名 | POST /kyc/individual/pi |
address_line_2 | 可选 | 居住地址第二行 | POST /kyc/individual/pi |
phone_isd_code | 可选 | 电话国际区号(与 phone_number 组成复合电话字段) | POST /kyc/individual/pi |
phone_number | 可选 | 电话号码(不含区号) | POST /kyc/individual/pi |
id_no | 可选 | 证件号码 | POST /kyc/individual/pi |
id_type | 可选 | 证件类型:passport / dl / id_card / residence_permit | POST /kyc/individual/pi |
id_doc_type | 可选 | 补充证件类型(附加信息) | POST /kyc/individual/pi |
id_doc_number | 可选 | 补充证件号码(附加信息) | POST /kyc/individual/pi |
created_at_partner | 可选 | 用户在合作方侧的注册时间 | POST /kyc/individual/pi |
kyc_finished_at_partner | 可选 | 用户在合作方侧完成 KYC 的时间 | POST /kyc/individual/pi |
gps_poa | 条件必填 | 基于 GPS 的地址证明,仅 SDK 流程 | 由 SDK 自动采集,无需调用接口 |
使用示例
// 场景一:新用户注册
{
"country_iso2_code": "US"
}
// 场景二:已注册用户进度查询
{
"uid": "12345"
}注意事项
1. 居住国变更与字段重验证
当用户的居住国家country_iso2_code信息发生变更时,其必填字段集合可能会相应调整。在此情况下,必须重新调用本接口以获取最新的字段要求,并验证用户资料是否已填写完整。
提示:为确保资料符合最新规范,请在用户更新
country_iso2_code后,触发本接口的重新调用与验证流程。
2. 手机号码字段结构
phone 参数为一个复合对象,包含以下两个子字段:
| 字段名 | 类型 | 必填 | 说明 |
|---|---|---|---|
phone_isd_code | String | 是 | 国际区号(例如:86) |
phone_number | String | 是 | 手机号码(不包含区号) |