v1

latestOpenAPI 3.0.22026-07-26123510445.2 KB

Cardholders

List Cardholders

Returns a list of issuing cardholder objects. The objects are sorted in descending order by creation date, with the most recently created object appearing first.

get/v1/issuing/cardholders

Query parameters

page_sizeinteger required

Example:10

The maximum number of items to return per page. This number can be between 1 - 100

page_numberinteger required

Example:1

The page number to retrieve the next set of items. The number has to be greater than 1.

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

Example:PENDING

Retrieve items with the specified cardholder status. Matches any cardholder status if unspecified.

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.

Response

OK - Successfully retrieved a list of cardholders.

total_pagesinteger

The total pages of available items.

total_itemsinteger

The total counts of available items.

Example response

{
  "total_pages": 10,
  "total_items": 105,
  "data": [
    {
      "cardholder_id": "7c4ff2cd-1bf6-4aaa-bf16-266771425011",
      "email": "demo@example.com",
      "number_of_cards": 1,
      "first_name": "Emily",
      "last_name": "Toy",
      "create_time": "2024-05-09 15:52:23",
      "date_of_birth": "1990-01-01",
      "country_code": "SG",
      "phone_number": "86683306",
      "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"
      },
      "review_status": "SUCCESS",
      "idv_verification_url": "https://idv.sumsub.com/verify/abc123",
      "idv_url_expires_at": "2026-04-10T10:00:00+08:00"
    }
  ]
}