Update Cardholder
Cardholders
Update Cardholder
Update cardholder personal information, metadata, or status. PATCH /cardholders/.
PATCH
Update Cardholder
Overview
Update cardholder information. Only the fields you provide will be updated. Note that the email address cannot be changed after creation.Path Parameters
| Parameter | Type | Description |
|---|---|---|
id | string | Unique cardholder identifier |
Updatable Fields
| Field | Type | Description |
|---|---|---|
firstName | string | First name |
lastName | string | Last name |
phone | string | Phone number in E.164 format |
dateOfBirth | string | Date of birth (YYYY-MM-DD, must be 18+) |
gender | string | Gender (MALE or FEMALE) |
address | string | Street address |
city | string | City |
state | string | State or province |
country | string | ISO country code (2 chars) |
zipCode | string | Postal/ZIP code |
documentType | string | Document type (PASSPORT, NATIONAL_ID, DRIVER_LICENSE) |
documentNumber | string | Document number |
externalId | string | Your system’s identifier |
status | string | Status (ACTIVE, INACTIVE, SUSPENDED) |
metadata | object | Custom key-value data (merge semantics, see below) |
Metadata (Merge Semantics)
Themetadata field uses merge semantics on update:
- Add a key: include the key with a value
- Update a key: include the key with a new value
- Delete a key: set the key to
nullor"" - Keys you don’t include are left unchanged
Example Usage
Example Response
The response returns the complete updated cardholder data:Suspend/Reactivate Cardholder
You can change the cardholder’s status to temporarily suspend or reactivate them:The
email field cannot be updated after cardholder creation. If you need to change the email, you must delete the cardholder and create a new one.The
documentType and documentNumber fields are locked once the cardholder’s KYC status is ACCEPTED or SUBMITTED. You cannot modify document information after KYC verification.Authorizations
JWT access token obtained from /auth/token
Path Parameters
Unique cardholder identifier
Body
application/json
Cardholder's first name
Required string length:
1 - 100Cardholder's last name
Required string length:
1 - 100Phone number with country code
Required string length:
6 - 20Date of birth (YYYY-MM-DD)
Gender
Available options:
MALE, FEMALE, OTHER Street address
Maximum string length:
255City
Maximum string length:
100State or province
Maximum string length:
100ISO 3166-1 alpha-2 country code
Required string length:
2Postal/ZIP code
Maximum string length:
20Type of identification document
Available options:
PASSPORT, NATIONAL_ID, DRIVER_LICENSE Document identification number
Maximum string length:
50Your system's identifier
Maximum string length:
100Cardholder status
Available options:
ACTIVE, INACTIVE, SUSPENDED 
