List cardholders
GET
/v1/cardholdersRequires an API client bearer token.
Lists cardholders for the authenticated tenant. Newest first; cursor-paginated (pass the last row's id as starting_after). Optionally filtered by a case-insensitive exact-match email, by a case-insensitive substring match on full_name (q), or narrowed to one programme via programme_id. Alternatively, pass ids (comma-separated, 1..100) for a batch-get by id; ids and starting_after are mutually exclusive.
Parameters
Query parameters
| Name | Required | Description |
|---|---|---|
| optional | ||
| q | optional | |
| programme_id | optional | |
| ids | optional | |
| limit | optional | |
| starting_after | optional |
Example
curl https://api.rigid.fi/v1/cardholders \
-H "Authorization: Bearer $RIGID_API_TOKEN"Responses
200A page of cardholders.
dataarray of objectrequired
+ show properties− hide properties
idstring (uuid)required
programme_idstring (uuid)required
full_namestringrequired
emailstringrequired
phonestring | nullrequired
countrystringrequired
kyc_state"unverified" | "pending" | "passed" | "failed" | "in_review"required
attestedbooleanrequired
attested_bystring | nullrequired
attested_atstring | nullrequired
kyc_completebooleanrequired
funding_account_idstring | nullrequired
funding_currencystring | nullrequired
created_atstringrequired
has_morebooleanrequired
next_cursorstring (uuid) | nullrequired
400Validation error
typestringrequired
titlestringrequired
statusintegerrequired
detailstring
instancestring
401Authentication required
typestringrequired
titlestringrequired
statusintegerrequired
detailstring
instancestring
403Forbidden
typestringrequired
titlestringrequired
statusintegerrequired
detailstring
instancestring
500Internal server error
typestringrequired
titlestringrequired
statusintegerrequired
detailstring
instancestring