---
title: "Update Cardholder"
method: POST
path: "/v1/issuing/cardholders/{id}"
tags: ["Cardholders"]
---

# Update Cardholder

`POST /v1/issuing/cardholders/{id}`

Updates the specified issuing cardholder object by setting the values of the parameters passed. Any parameters not provided will be left unchanged (first name and last name cannot be accepted and updated).

## Path parameters

- `id` string, uuid, required

## Headers

- `x-on-behalf-of` string
- `x-idempotency-key` string, uuid

## Request body

- CardholderUpdateRequest
  - `country_code` string — Two-letter country code [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2).
  - `email` string — The cardholder's email address.
  - `phone_number` string — The cardholder's phone number. See [Phone number validation rules](/card-issuance/v1.6/guide/phone-number-validation-rules-for-cardholder) for length validation details.
  - `date_of_birth` string — The cardholder's birth date with `yyyy-mm-dd` format.
  - `gender` 'MALE' | 'FEMALE' — The cardholder's gender. * `MALE` - Male. * `FEMALE` - Female.
  - `nationality` string — The cardholder's nationality in ISO 3166-1 alpha-2 format. Required for STANDARD and ENHANCED KYC levels.
  - `residential_address` ResidentialAddress — The cardholder's residential address. All fields accept only letters (A-Z, a-z), digits (0-9), spaces, and the following punctuation: `, . ' / # ( ) - &`. Requests containing any other character are rejected — correct the value and resubmit. Empty optional fields are not validated.
    - `country` string, required — Two-letter country code [ISO 3166-1 alpha-2](https://en.wikipedia.org/wiki/ISO_3166-1_alpha-2).
    - `state` string — State, county, province, or region.
    - `city` string, required — City, district, suburb, town, or village.
    - `district` string — District or sub-region within the city.
    - `line1` string, required — Address line 1 (e.g., street, PO Box, or company name).
    - `line2` string — Address line 2 (e.g., apartment, suite, unit, or building).
    - `line_en` string — Address in English.
    - `postal_code` string — ZIP or postal code. If you intend to issue an Enhanced card, this field must be 4-10 characters long.
  - `identity` Identity — The cardholder's identity document information. Required for STANDARD and ENHANCED KYC levels.
    - `type` 'ID_CARD' | 'PASSPORT', required — Identity document type. * `ID_CARD` - National identity card. * `PASSPORT` - Passport.
    - `number` string, required — Identity document number.
    - `front_file` string, required — Base64 encoded front side image of the identity document.
    - `back_file` string — Base64 encoded back side image of the identity document. Required when `type` is `ID_CARD`.
    - `hand_file` string — Base64 encoded hand-held identity document photo.
  - `kyc_verification` KycVerification — KYC verification information. Required for ENHANCED KYC level.
    - `method` 'THIRD_PARTY' | 'SUMSUB_REDIRECT', required — The KYC verification method. * `THIRD_PARTY` - Merchant has completed verification via a third-party provider and submits proof. * `SUMSUB_REDIRECT` - Redirect the cardholder to Sumsub for IDV verification.
    - `kyc_proof` KycProof — Third-party KYC verification proof. Required when `method` is `THIRD_PARTY`.
      - `provider` string, required — The third-party KYC provider name (e.g., `SUMSUB`).
      - `reference_id` string, required — The reference ID from the third-party provider. Must be at least 10 characters and globally unique.
      - `documents` KycProofDocument[], required — Compliance report files backing the third-party verification. Each entry points to a file previously uploaded through [Upload A File](/account-center/v1.6/api-reference/upload-file). You must provide an identity verification report — either a standalone `IDV` report or a combined `IDV_AML` report. An anti-money-laundering (`AML`) report is optional. Submit the reports as separate files (`IDV` plus `AML`) or as a single combined file (`IDV_AML`).
        - `file_id` string, required — The ID of an uploaded file, returned by [Upload A File](/account-center/v1.6/api-reference/upload-file).
        - `report_type` 'IDV' | 'AML' | 'IDV_AML', required — The compliance report the file contains. * `IDV` - An identity verification report only. * `AML` - An anti-money-laundering screening report only. * `IDV_AML` - A single file covering both identity verification and anti-money-laundering.
  - `document_type` 'pdf' | 'png' | 'jpg' | 'jpeg' — The type of the identification document.
  - `document` string — Base64 encoded identification document string, 2MB limitation.

## Response `200`

Cardholder update successfully.

- CardholderCreationResponse
  - `cardholder_id` string, uuid, required — The cardholder's unique identifier.
  - `cardholder_status` 'FAILED' | 'PENDING' | 'SUCCESS' | 'INCOMPLETE', required — The cardholder's status.
  - `idv_verification_url` string — IDV verification URL. Returned when `kyc_verification.method` is `SUMSUB_REDIRECT`.
  - `idv_url_expires_at` string — IDV verification URL expiration time in RFC 3339 format. Returned when `kyc_verification.method` is `SUMSUB_REDIRECT`.

---

[API](https://skmtc.dev/uqpay/apis/authentication-api.md) · [All operations](https://skmtc.dev/uqpay/apis/authentication-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/uqpay/authentication-api/revisions/cef532a10777/schema)