Documentation Index
Fetch the complete documentation index at: https://docs.fyatu.com/llms.txt
Use this file to discover all available pages before exploring further.
A cardholder is an individual identity record in your card program. Each cardholder must be created and KYC-verified before cards can be issued to them. Cardholders are created programmatically via the V3.20 API — the portal provides oversight, filtering, and manual lifecycle controls.
Cardholder List
Navigate to Cardholders in the portal sidebar to see all cardholder records for the active environment. Use the filters to narrow results:
| Filter | Options |
|---|
| Status | ACTIVE, SUSPENDED, TERMINATED |
| KYC Status | PENDING, APPROVED, REJECTED |
| Search | Name or email address |
KYC Status
KYC (Know Your Customer) verification must be approved before a card can be issued to a cardholder.
| Status | Description |
|---|
| Pending | Cardholder created, verification not yet started or in progress |
| Approved | Identity verified — cards can be issued |
| Rejected | Verification failed — review the rejection reason and update the cardholder record |
KYC verification is handled externally by your platform. You submit cardholder identity data (name, DOB, address, nationality, and optionally a KYC document) when creating or updating the cardholder via the API.
Cardholder Detail
Click any cardholder in the list to view:
- Identity — full name, email, phone, date of birth, nationality
- Address — street address, city, state, postal code, country
- Status & KYC — current lifecycle status and KYC verification result
- Cards — all cards issued to this cardholder, with status and balance
- External ID — your platform’s reference ID for this cardholder
- Timeline — creation date and status change history
Cardholder Actions
| Action | When Available | Description |
|---|
| Suspend | Status is ACTIVE | Temporarily blocks the cardholder from card activity. Cards linked to this cardholder are not automatically frozen. |
| Reactivate | Status is SUSPENDED | Restores the cardholder to ACTIVE status. |
| Terminate | Status is ACTIVE or SUSPENDED | Permanently closes the cardholder record. This action is irreversible. |
Cardholder Data Fields
When creating a cardholder via the API, the following fields are accepted:
| Field | Required | Description |
|---|
firstName | Yes | Legal first name |
lastName | Yes | Legal last name |
email | Yes | Contact email |
phone | Yes | Phone number in E.164 format |
dateOfBirth | Yes | Date of birth (YYYY-MM-DD) |
nationality | Yes | ISO 3166-1 alpha-2 country code |
address.address | Yes | Street address |
address.city | Yes | City |
address.country | Yes | ISO 3166-1 alpha-2 country code |
address.state | No | State or province |
address.postalCode | No | Postal / ZIP code |
externalId | No | Your platform’s reference ID for this cardholder |
kycDocument | No | KYC document object (type, number, issuing country, document URLs) |
