跳转到主要内容
POST
Update Cardholder

授权

x-auth-token
string
header
必填

由 UQPay 提供的登录 API Token。

请求头

x-on-behalf-of
string

指定代表哪个子账户发起请求。应设置为 account_id,该值可通过 List Connected Accounts 接口获取。若省略或为空,则请求以主账户身份执行。 更多信息参见 关联账户

x-idempotency-key
string<uuid>
必填

用于维持操作幂等性的唯一标识符(UUID),确保同一操作的重复执行不会产生意外影响或重复。它有助于在网络错误、重试或失败的情况下保持数据一致性。

路径参数

id
string<uuid>
必填

资源的全局唯一标识符(UUID v4)。

示例:

"71fdb0fe-9682-457a-9361-e8868694f12f"

请求体

application/json
country_code
string

两位国家代码 ISO 3166-1 alpha-2

Maximum string length: 2
示例:

"SG"

email
string

持卡人的电子邮箱地址。

示例:

"demo@example.com"

phone_number
string

持卡人的电话号码。

长度校验详情参见 电话号码校验规则

示例:

"86683306"

date_of_birth
string

持卡人的出生日期,格式为 yyyy-mm-dd

示例:

"1990-01-01"

gender
enum<string>

持卡人的性别。

  • MALE - 男。
  • FEMALE - 女。
可用选项:
MALE,
FEMALE
示例:

"MALE"

nationality
string

持卡人的国籍,采用 ISO 3166-1 alpha-2 格式。STANDARD 和 ENHANCED KYC 等级必填。

Required string length: 2
示例:

"SG"

residential_address
object

持卡人的居住地址。

所有字段只接受字母(A-Z、a-z)、数字(0-9)、空格,以及以下标点:, . ' / # ( ) - &。包含其他任何字符的请求都会被拒绝——请修正后重新提交。为空的可选字段不做校验。

identity
object

持卡人的身份证件信息。STANDARD 和 ENHANCED KYC 等级必填。

kyc_verification
object

KYC 验证信息。ENHANCED KYC 等级必填。

document_type
enum<string>

身份证件的类型。

可用选项:
pdf,
png,
jpg,
jpeg
示例:

"pdf"

document
string

Base64 编码的身份证件字符串,限制 2MB。

响应

200 - application/json

成功更新持卡人。

cardholder_id
string<uuid>
必填

持卡人的唯一标识符。

示例:

"7c4ff2cd-1bf6-4aaa-bf16-266771425011"

cardholder_status
enum<string>
默认值:SUCCESS
必填

持卡人的状态。

可用选项:
FAILED,
PENDING,
SUCCESS,
INCOMPLETE
idv_verification_url
string

IDV 验证 URL。当 kyc_verification.methodSUMSUB_REDIRECT 时返回。

示例:

"https://idv.sumsub.com/verify/abc123"

idv_url_expires_at
string

IDV 验证 URL 的过期时间,RFC 3339 格式。当 kyc_verification.methodSUMSUB_REDIRECT 时返回。

示例:

"2026-04-10T10:00:00+08:00"