> ## Documentation Index
> Fetch the complete documentation index at: https://docs.lead.bank/llms.txt
> Use this file to discover all available pages before exploring further.

# Schema

<Warning>
  **Upcoming Change**

  We're introducing support for multiple card products under a single program, including programs with different funds flows and settlement requirements. Partners adopting this functionality will need to update network settlement file processing and transaction file generation before September 30, 2026.

  👉 [View Details](/upcoming-changes#multi-card-program-file-updates)
</Warning>

<Info>
  This file provides information on all issued cards.
</Info>

<Check>
  Card files should include all newly created cards and any cards that have been updated.

  For all optional fields where you do not plan to pass through data, please include the header and an empty value.
</Check>

## IDs

| **Field**                   | **Description**                                                                                                                                                                                          | **Required** | **Data Type** |
| --------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ------------ | ------------- |
| client\_card\_id            | Unique ID of the card issued. Cannot start with `card_` (reserved for Lead-generated card IDs).                                                                                                          | Required     | string        |
| account\_id                 | Unique ID of an account created through the [Account](/file-integrations/account/schema) file.                                                                                                           | Required     | string        |
| entity\_id                  | Unique ID of a customer created through the [Customer](/file-integrations/customer/customer-schema) file or an entity created through the [Entity API](/api-reference/endpoint/entity/create-an-entity). | Required     | string        |
| client\_card\_product\_name | The name of the card product in the client's system.                                                                                                                                                     | Required     | string        |

## Card Metadata

| **Field**   | **Description**                                              | **Required** | **Data Type** |
| :---------- | :----------------------------------------------------------- | :----------- | :------------ |
| is\_virtual | True if the card is a virtual card; false if physical.       | Required     | boolean       |
| card\_type  | enum<br />`hsa`<br />`fsa`<br />`consumer`<br />`commercial` | Required     | enum          |

## Status & Timing

| **Field**      | **Description**                                                                                                                                                                                                                                                                                                                                                              | **Required**                      | **Data Type**          |
| :------------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :-------------------------------- | :--------------------- |
| created\_at    | Datetime the card was created.                                                                                                                                                                                                                                                                                                                                               | Required                          | datetime<br />ISO8601  |
| card\_status   | enum<br />`active`<br />`closed`<br />`inactive`<br />`expired`<br /><br />A closed Card cannot be re-opened and Lead's system will reject any additional changes or activity reported once it is in a `closed` status. If there is a chance that activity may still occur on the Card, use the `inactive` status until it is confirmed that no further activity will occur. | Required                          | enum                   |
| activated\_at  | Datetime the card was activated and able to charge transactions. Must be >= to created\_at and \< expiry\_date, if expiry\_date is present                                                                                                                                                                                                                                   | Required                          | datetime<br />ISO8601  |
| expiry\_date   | Date the card expires.                                                                                                                                                                                                                                                                                                                                                       | Required                          | date<br />`YYYY-MM-DD` |
| closed\_at     | Datetime the card was closed. Must be >= to created\_at                                                                                                                                                                                                                                                                                                                      | Required if card\_status = closed | datetime<br />ISO8601  |
| closed\_reason | The reason for closing the card.                                                                                                                                                                                                                                                                                                                                             | Required if card\_status = closed | string                 |
| replaced\_by   | The card ID that replaced this card if expired, lost, or canceled.                                                                                                                                                                                                                                                                                                           | Optional                          | string                 |

## Other

| **Field**     | **Description**                                                                                     | **Required** | **Data Type**         |
| :------------ | :-------------------------------------------------------------------------------------------------- | :----------- | :-------------------- |
| generated\_at | The day this file is generated. This should always be the date the file is sent to Lead Bank.       | Required     | datetime<br />ISO8601 |
| effective\_at | The timestamp of when the related object(s) were polled to collect the information for this record. | Required     | datetime<br />ISO8601 |