Get a cardholder

Retrieve a cardholder, or a specific version of it. Sensitive fields are masked unless reveal_sensitive is true.

Required permissions: cardholder:read.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

cardholder_idstringRequired

Query parameters

versionintegerOptional>=0Defaults to 0
Cardholder version. Zero selects latest.
reveal_sensitivebooleanOptionalDefaults to false
Whether to include unmasked sensitive fields in the response. Defaults to false.

Response

The cardholder.
IndividualCardholderobject

An individual cardholder, as shown to clients through the client-facing API.

OR
CorporateCardholderobject

A corporate cardholder, as shown to clients through the client-facing API.

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
422
Unprocessable Entity Error
429
Too Many Requests Error
500
Internal Server Error