Skip to content

List cardholders

GET/v1/cardholders

Requires an API client bearer token.

Lists cardholders for the authenticated tenant. Cursor-paginated on id. Optionally filtered by a case-insensitive exact-match email, or by a case-insensitive substring match on full_name (q).

Parameters

Query parameters

NameRequiredDescription
emailoptional
qoptional
limitoptional
starting_afteroptional

Example

curl https://api.rigid.fi/v1/cardholders \
  -H "Authorization: Bearer $RIGID_API_TOKEN"

Responses

200

A page of cardholders.

dataarray of objectrequired
+ show 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
400

Validation error

typestringrequired
titlestringrequired
statusintegerrequired
detailstring
instancestring
401

Authentication required

typestringrequired
titlestringrequired
statusintegerrequired
detailstring
instancestring
403

Forbidden

typestringrequired
titlestringrequired
statusintegerrequired
detailstring
instancestring
500

Internal server error

typestringrequired
titlestringrequired
statusintegerrequired
detailstring
instancestring