跳转到主要内容
POST
/
v1
/
issuing
/
cardholders
Create Cardholder
curl --request POST \
  --url https://api-sandbox.uqpaytech.com/api/v1/issuing/cardholders \
  --header 'Content-Type: application/json' \
  --header 'x-auth-token: <api-key>' \
  --header 'x-idempotency-key: <x-idempotency-key>' \
  --data '
{
  "email": "[email protected]",
  "first_name": "Emily",
  "last_name": "Toy",
  "country_code": "SG",
  "phone_number": "86683306",
  "date_of_birth": "1990-01-01",
  "gender": "MALE",
  "nationality": "SG",
  "document_type": "pdf",
  "document": "<string>"
}
'
{
  "cardholder_id": "7c4ff2cd-1bf6-4aaa-bf16-266771425011",
  "cardholder_status": "SUCCESS",
  "idv_verification_url": "https://idv.sumsub.com/verify/abc123",
  "idv_url_expires_at": "2026-04-10T10:00:00+08:00"
}

Documentation Index

Fetch the complete documentation index at: https://developers-sandbox.uqpaytech.com/llms.txt

Use this file to discover all available pages before exploring further.

授权

​
x-auth-token
string
header
必填

The API token for login provided by UQPay.

请求头

​
x-on-behalf-of
string

Specifies the sub-account on whose behalf the request is made. This should be set to the account_id, which can be retrieved via the List Connected Accounts endpoint. If omitted or empty, the request is executed using the master account. More information at Connected Accounts.

​
x-idempotency-key
string<uuid>
必填

A unique identifier (UUID) used to maintain operation idempotency, ensuring that repeated executions of the same operation do not result in unintended effects or duplication. It helps preserve data consistency in the face of network errors, retries, or failures.

请求体

application/json
​
email
string
必填

The cardholder’s email address.

示例:

"[email protected]"

​
first_name
string
必填

The first name of the cardholder. Must be between 1 and 40 characters, containing only alphabetic characters and spaces. Spaces are not allowed at the beginning or end of the name.

示例:

"Emily"

​
last_name
string
必填

The last name of the cardholder. Must be between 1 and 40 characters, containing only alphabetic characters and spaces. Spaces are not allowed at the beginning or end of the name.

示例:

"Toy"

​
country_code
string
必填

Two-letter country code ISO 3166-1 alpha-2.

Maximum string length: 2
示例:

"SG"

​
phone_number
string
必填

The cardholder’s phone number.

See Phone number validation rules for length validation details.

示例:

"86683306"

​
date_of_birth
string

The cardholder's birth date with yyyy-mm-dd format.

示例:

"1990-01-01"

​
gender
enum<string>

The cardholder's gender.

  • MALE - Male.
  • FEMALE - Female.
可用选项:
MALE,
FEMALE
示例:

"MALE"

​
nationality
string

The cardholder's nationality in ISO 3166-1 alpha-2 format. Required for STANDARD and ENHANCED KYC levels.

Required string length: 2
示例:

"SG"

​
residential_address
object

The cardholder’s residential address.

​
identity
object

The cardholder's identity document information. Required for STANDARD and ENHANCED KYC levels.

​
kyc_verification
object

KYC verification information. Required for ENHANCED KYC level.

​
document_type
enum<string>

The type of the identification document.

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

"pdf"

​
document
string

Base64 encoded identification document string, 2MB limitation.

响应

200 - application/json

Cardholder creation successfully.

​
cardholder_id
string<uuid>
必填

The cardholder’s unique identifier.

示例:

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

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

The cardholder's status.

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

IDV verification URL. Returned when kyc_verification.method is SUMSUB_REDIRECT.

示例:

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

​
idv_url_expires_at
string

IDV verification URL expiration time in RFC 3339 format. Returned when kyc_verification.method is SUMSUB_REDIRECT.

示例:

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