List Cardholders

List cardholders under the current account, optionally filtered by status, using cursor-based pagination. Deleted cardholders are removed permanently and never appear in the results.
Request Parameters
statusstring
Filter results by cardholder status. Omit to return cardholders in all statuses.

Valid Values:

PENDING — Under review, awaiting KYC verification.
ACTIVE — Review passed; cards can be issued to this cardholder.
FAILED — Review failed or the cardholder was rejected.
limitinteger
required
Number of records to return per page. Range 1–50; defaults to 20.
cursorstring
Pagination cursor. Omit on the first request, then pass the nextCursor from the previous response to fetch the next page.
Response Parameters
resultResult
See Result.
itemsarray of Cardholder
Cardholders on this page. Each entry carries the same fields as Query a Cardholder. Returns an empty list if no cardholder matches the filter.
Show child parametersShow child parameters
nextCursorstring
Cursor for the next page. Not returned when there is no more data — treat its absence as the end of the result set.
prevCursorstring
Cursor for the previous page.
totalCountinteger
Total number of matching cardholders. Returned only when the query conditions allow it, so do not rely on it for paging control.
Error Codes
resultCoderesultStatusresultMessageTroubleshooting
SUCCESSSSuccess.Query succeeded.
PARAM_ILLEGALFIllegal parameters exist.Verify `limit` is within 1–50 and `status` is a supported value.
AUTHORIZATION_NOT_EXISTFThe authorization relationship does not exist.Verify the `account-id` / `access-token` authorization before retrying.
USER_NOT_EXISTFThe user does not exist.Retry with correct user information.
Definition
POST /api/open/v1/issuing/cardholders/list
Request
{
"status": "ACTIVE",
"limit": 20
}
Response
{
"result": {
  "resultCode": "SUCCESS",
  "resultMessage": "success",
  "resultStatus": "S"
},
"items": [
  {
    "id": "ch_abc123xyz",
    "type": "EMPLOYEE",
    "status": "ACTIVE",
    "personInfo": {
      "userName": {
        "firstName": "San",
        "lastName": "Zhang",
        "fullName": "San Zhang"
      },
      "dateOfBirth": "1990-06-15"
    },
    "nationality": "CHN",
    "createdAt": "2024-01-15T08:00:00Z"
  }
],
"nextCursor": "eyJsYXN0SWQiOiJjaF9hYmMxMjN4eXoifQ==",
"totalCount": 42
}