Skip to content

Get a cardholder's addresses

GET/v1/cardholders/{id}/addresses

Requires an API client bearer token.

The current billing and delivery address, each null when none is on file. The billing address is the one address matching (AVS, 3-D Secure risk checks) compares against, and the one a card product that requires it checks before a card can be activated; the delivery address is where a card is sent.

Parameters

Path parameters

NameRequiredDescription
idrequired

Example

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

Responses

200

The current addresses.

billingobject | nullrequired

The current billing address, or null when none is on file.

+ show properties
idstring (uuid)required
cardholder_idstring (uuid)required
kind"billing" | "delivery"required
streetstringrequired
building_numberstring | nullrequired
line2string | nullrequired
postal_codestring | nullrequired
citystringrequired
regionstring | nullrequired
countrystringrequired
created_atstringrequired

When this address was set. For the current address: on file since.

deliveryobject | nullrequired

The current delivery address, or null when none is on file.

+ show properties
idstring (uuid)required
cardholder_idstring (uuid)required
kind"billing" | "delivery"required
streetstringrequired
building_numberstring | nullrequired
line2string | nullrequired
postal_codestring | nullrequired
citystringrequired
regionstring | nullrequired
countrystringrequired
created_atstringrequired

When this address was set. For the current address: on file since.

400

Validation error

typestringrequired
titlestringrequired
statusintegerrequired
detailstring
instancestring
401

Authentication required

typestringrequired
titlestringrequired
statusintegerrequired
detailstring
instancestring
403

Forbidden

typestringrequired
titlestringrequired
statusintegerrequired
detailstring
instancestring
404

Cardholder not found

typestringrequired
titlestringrequired
statusintegerrequired
detailstring
instancestring
500

Internal server error

typestringrequired
titlestringrequired
statusintegerrequired
detailstring
instancestring