/kyc/individual/file

文件上传API,用于上传用户证件或证明文件

接口详情

上传个人验证文件,此接口需针对每个文件单独调用,不支持批量上传。

调用说明

  1. 请为每一个文件单独调用一次本接口。
  2. 请求方式:POST,使用 multipart/form-data 上传。
  3. 文件内容:放在表单字段 raw_body 中,作为真实的文件上传——不是 base64 字符串,也不是裸二进制请求体。
  4. 其余参数:uid、file_name、file_type、file_category 以表单字段或 Query String 形式传递均可;其中 uid、file_name、file_type 必填,file_category 可选(仅 PoA 类文件使用)。

支持的文件格式

类型允许的扩展名允许的 MIME 类型
图片jpeg, jpg, png, bmp, tiff, heif, heic, webpimage/jpeg, image/jpg, image/png, image/bmp, image/tiff, image/heif, image/heic, image/webp
文档pdfapplication/pdf

文件大小限制

  • PDF 文件:最大不得超过 20 MB。
  • 图片文件:最大不得超过 17 MB。

多次上传规则

同一 file_type 允许重复上传。系统将保留最后一次上传的文件,并自动覆盖此前上传的同类型文件。

请按以下要求上传文件

  • 驾照与身份证:必须同时上传正面与背面,文件格式须为图片,不接受 PDF。
  • 护照、居住证明及地址证明:仅需上传正面,文件格式须为图片。
  • 本人自拍照:仅需上传正面清晰照片。
  • 居住地址证明:可上传图片或 PDF 格式的文件。

file_type 类型定义

参数 Key是否必填说明
id_file是身份证件正面(如护照、身份证、居留证或驾照)。仅支持图片格式,不接受 PDF。
id_back_file是身份证件背面(如身份证背面、驾照背面)。护照无背面,此项可选。仅支持图片格式,不接受 PDF。
selfie_file是本人自拍照。需露出完整面部,请勿佩戴眼镜等遮挡物。照片需光线充足、对焦清晰。
proof_of_address是(方案二不支持,见下)地址证明文件(如水电煤账单)。支持 JPG、JPEG、PNG 及 PDF 格式。如有可用类别,请指定 file_category。
⚠️

走 SDK v2 流程的用户,不能用本接口传地址证明。

如果您在 POST /kyc/individual/pi 里传了 kyc_flow=kyc_sdk_v2(也就是 方案二),那么:

  • 用 file_type=proof_of_address 调本接口会失败,返回错误码 303124;
  • 这类用户的地址证明由 SDK 自己收集——SDK 里会先让用户用 GPS 定位验证地址,不通过时再引导用户在 SDK 内上传文件。您不需要、也无法从后端代传。
  • 只有 id_file、id_back_file、selfie_file 这三类证件文件不受影响,仍可正常上传。

方案一(默认的 kyc_connect)和方案三(Sumsub Token Sharing)没有这个限制,proof_of_address 照常上传。

Query Params
string
required

用户唯一uid

string
required

文件名称

string
required

附件类型:证件正面照 (id_file)、证件背面照 (id_back_file)、自拍照 (selfie_file)、地址证明文件 (proof_of_address)。

string
enum

utility_bill ✕ 水电煤气账单
bank_statement ✕ 银行对账单
credit_card_statement ✕ 信用卡账单
lease_or_rental_agreement ✕ 租赁合同
mortgage_statement ✕ 房贷还款证明
mobile_bill ✕ 手机账单 类别。

Allowed:
file
required

原始二进制内容(Raw Binary)。允许文件后缀: jpeg, bmp,png,tiff,pdf,jpg

Responses

Language
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json