POST
Invite a cardholder to a card
Invites a customer to hold a specific card. The caller must own the card. On success the invited customer gets an invite email and the invite moves to INVITEDtrack it until they accept.

Authorizations

Authorization
string
header
required

The user's id_token from authentication — the ID token, not the access_token. The program and environment come from the token.

Path Parameters

customerId
string
required

The customer's id.

accountId
string
required

The account the card belongs to. A customer can have several accounts; cards are issued against one.

cardId
string
required

The card id from create / get cards.

Body

application/json
invitedCustomerId
string
required

Required. The customer being invited to hold this card.

Response

Invited

success
boolean
Example:

true

message
string
Example:

"Cardholder invitation completed successfully"