Skip to main content
GET
Find Cardholder

Authorizations

Ocp-Apim-Subscription-Key
string
header
required

The APIM subscription key.

Query Parameters

customerId
string

External entity identifier from the institution's system of record.

Pattern: ^[0-9a-zA-Z]{1,16}$

Response

The cardholder response.

The cardholder model

id
string<uuid>
required

The cardholder identifier in UUID format.

customerId
string
required

External entity identifier from the institution's system of record.

Maximum string length: 16
Pattern: ^[0-9a-zA-Z]{1,16}$
lastName
string
required

The last name of the cardholder.

Maximum string length: 255
firstName
string

The first name of the cardholder.

Maximum string length: 255
middleName
string

The middle name of the cardholder.

Maximum string length: 255
preferredName
string

The cardholder's preferred name.

Maximum string length: 255