Sign in

v1

latestOpenAPI 3.0.22026-07-26123510445.2 KB
Cardholders

Update Cardholder

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).

post/v1/issuing/cardholders/{id}

Path parameters

idstring uuid required
Example:b3d9d2d5-4c12-4946-a09d-953e82sed2b0

Universally unique identifier (UUID v4) of a resource.

Headers

x-on-behalf-ofstring

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 API. If omitted or empty, the request is executed using the master account. More information at Connected Accounts.

x-idempotency-keystring 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.

Request body

country_codestring

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

emailstring

The cardholder's email address.

phone_numberstring

The cardholder's phone number.

See Phone number validation rules for length validation details.

date_of_birthstring

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

gender'MALE' | 'FEMALE'

The cardholder's gender.

  • MALE - Male.
  • FEMALE - Female.
nationalitystring

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

document_type'pdf' | 'png' | 'jpg' | 'jpeg'

The type of the identification document.

documentstring

Base64 encoded identification document string, 2MB limitation.

Example request

{
  "country_code": "SG",
  "email": "demo@example.com",
  "phone_number": "86683306",
  "date_of_birth": "1990-01-01",
  "gender": "MALE",
  "nationality": "SG",
  "residential_address": {
    "country": "SG",
    "state": "Singapore",
    "city": "Singapore",
    "district": "Buona Vista",
    "line1": "9 N Buona Vista Dr",
    "line2": "THE METROPOLIS",
    "line_en": "9 N Buona Vista Dr, THE METROPOLIS",
    "postal_code": "138666"
  },
  "identity": {
    "type": "PASSPORT",
    "number": "E12345678"
  },
  "kyc_verification": {
    "method": "THIRD_PARTY",
    "kyc_proof": {
      "provider": "SUMSUB",
      "reference_id": "sumsub_ref_1234567890",
      "documents": [
        {
          "file_id": "b3d9d2d5-4c12-4946-a09d-953e82sed2b0",
          "report_type": "IDV"
        }
      ]
    }
  },
  "document_type": "pdf"
}

Response

Cardholder update successfully.

cardholder_idstring uuid required

The cardholder's unique identifier.

cardholder_status'FAILED' | 'PENDING' | 'SUCCESS' | 'INCOMPLETE' required

The cardholder's status.

idv_verification_urlstring

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

idv_url_expires_atstring

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

Example response

{
  "cardholder_id": "7c4ff2cd-1bf6-4aaa-bf16-266771425011",
  "idv_verification_url": "https://idv.sumsub.com/verify/abc123",
  "idv_url_expires_at": "2026-04-10T10:00:00+08:00"
}