> ## 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

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

## IDs & Details

| **Field**               | **Description**                                                                                                                           | **Required**                                                                                  | **Data Type**                                                                                 |
| ----------------------- | ----------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------- |
| client\_application\_id | A unique ID for the application generated by your system. Cannot start with `application_` (reserved for Lead-generated application IDs). | Required                                                                                      | string                                                                                        |
| account\_holder\_type   | Type of account holder.                                                                                                                   | Required                                                                                      | enum:<br />`consumer`<br />`commercial`                                                       |
| account\_holders        | IDs of any account holders and co-holders.                                                                                                | Required                                                                                      | JSON:<br />\<client\_customer\_id or entity\_id>                                              |
| authorized\_signers     | A list of authorized signers. These are persons who can access, control and change products and services on the account.                  | Required with `min_size` >= 1 if `account_holder_type` = `commercial` and `status = approved` | An array of authorized signer IDs<br /><br />JSON:<br />\<client\_customer\_id or entity\_id> |
| currency                | Application currency code. 3 letter code, e.g. USD                                                                                        | Required                                                                                      | [ISO4217](https://www.iso.org/iso-4217-currency-codes.html)                                   |
| client\_product\_name   | Name of the product offered by the client                                                                                                 | Required                                                                                      | string                                                                                        |
| is\_secured             | Indicate if the product is a secured credit or secured deposit product - e.g. will have collateral attached.                              | Required                                                                                      | boolean                                                                                       |

## Status & Timing

| **Field**        | **Description**                                                                             | **Required**                                              | **Data Type**                                                                              |
| :--------------- | :------------------------------------------------------------------------------------------ | :-------------------------------------------------------- | :----------------------------------------------------------------------------------------- |
| created\_at      | Datetime application initiated.                                                             | Required                                                  | datetime<br />[ISO8601](https://www.iso.org/iso-8601-date-and-time-format.html)            |
| submitted\_at    | Datetime the application was submitted.                                                     | Required                                                  | datetime<br />[ISO8601](https://www.iso.org/iso-8601-date-and-time-format.html)            |
| status           | See [Application Statuses](/file-integrations/application/statuses)                         | Required                                                  | enum:<br />`submitted`<br />`under_review`<br />`approved`<br />`declined`<br />`canceled` |
| decided\_at      | Datetime a final decision (`approved`, `declined`, `canceled`) was made on the application. | Required if `status` = `approved`, `declined`, `canceled` | datetime<br />[ISO8601](https://www.iso.org/iso-8601-date-and-time-format.html)            |
| decision\_reason | The reason for the final status of `approved`, `declined`, `canceled`                       | Required if `status` = `approved`, `declined`, `canceled` | String                                                                                     |

## <Tooltip tip="Adverse Action Notice">AAN</Tooltip> & Exception Approval

| **Field**               | **Description**                                                                                                                                     | **Required**                                 | **Data Type**                                                                   |
| :---------------------- | :-------------------------------------------------------------------------------------------------------------------------------------------------- | :------------------------------------------- | :------------------------------------------------------------------------------ |
| aan\_delivered\_at      | The datetime the AAN was delivered.                                                                                                                 | Required if `status` = `declined`            | datetime<br />[ISO8601](https://www.iso.org/iso-8601-date-and-time-format.html) |
| aan\_reason             | Reason an adverse action notice (AAN) was sent to the customer.                                                                                     | Required if `status` = `declined`            | string                                                                          |
| aan\_delivery\_method   | AAN delivery method.                                                                                                                                | Required if `status` = `declined`            | enum:<br />`email`<br />`text`<br />`other`                                     |
| is\_exception\_approval | `true` if the application would not have been accepted without some kind of exception, such as a credit limit decision override; `false` otherwise. | Required                                     | boolean                                                                         |
| exception\_reason       | The reason this application was approved as an exception, such as an overridden credit limit decision.                                              | Required if `is_exception_approval` = `true` | string                                                                          |

## Compliance

| **Field** | **Description**                                                                                                                                                                                                                                                     | **Required** | **Data Type**                                                                                                                                                                                                                                                                                                                                                                                                                                                                                                    |
| :-------- | :------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | :----------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| documents | An array of JSON hash of customer-facing documents. The JSON hash should include the name of the document, and client\_document\_name or document\_id that's been uploaded to Documents folder. This will be defined between the client and Lead bank during setup. | Required     | **Example**<br /><br />"document\_id": "client\_document\_123", "type":"esign\_agreement","consented\_at":"2025-12-31T15:38:34.101-06:00","version":"20220202"<br /><br />For documents uploaded via SFTP, please input the full file name as document\_id. The suggested naming convention is: `<Date>_<ApplicationID>_<FileType>_<Version>.<FileExtension>`<br /><br />Note: JSON strings embedded in CSV fields must be enclosed in double quotes, with internal double quotes escaped by doubling them (""). |

## Credit Details

| **Field**           | **Description**                                                                                                               | **Required**                                                          | **Data Type**                                                                      |
| :------------------ | :---------------------------------------------------------------------------------------------------------------------------- | :-------------------------------------------------------------------- | :--------------------------------------------------------------------------------- |
| is\_mla             | `true` if the customer is subject to the Military Lending Act; `false` otherwise                                              | Required for credit products                                          | boolean                                                                            |
| underwriting\_grade | The grade or score given to the customer based on underwriting.                                                               | Required for credit products AND `status` in (`approved`, `declined`) | string                                                                             |
| credit\_limit       | The maximum amount the customer can draw. This may be different from the max credit limit the customer has been approved for. | Required for credit products AND `status` = `approved`                | number<br /><br />[currency decimal ](/file-integrations/file-delivery/currencies) |
| max\_credit\_limit  | The maximum credit limit the customer has been approved for based on original underwriting and the product.                   | Required for credit products AND `status` = `approved`                | number<br /><br />[currency decimal](/file-integrations/file-delivery/currencies)  |

## Credit Bureau Data

| **Field**                         | **Description**                                                                                                                  | **Required**                                                                                                                                                                                                                                                                       | **Data Type**                                                                         |
| :-------------------------------- | :------------------------------------------------------------------------------------------------------------------------------- | :--------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | :------------------------------------------------------------------------------------ |
| credit\_pulled\_at                | The date the credit report is pulled.                                                                                            | Required if your program's underwriting policy requires credit bureau data on all applications. This will be agreed upon with Lead's Legal team during implementation.  Required if any of `credit_score`, `credit_report_non_score_value`, or `credit_report_source` are present. | datetime<br /><br />[ISO8601](https://www.iso.org/iso-8601-date-and-time-format.html) |
| credit\_score                     | Credit score given by the credit bureau. Supported range is 300 to 850. Mutually exclusive with `credit_report_non_score_value`. | Required if your program's underwriting policy requires credit bureau data on all applications. This will be agreed upon with Lead's Legal team during implementation  Required if credit bureau data is present and `credit_report_non_score_value` is not provided.              | number                                                                                |
| credit\_report\_non\_score\_value | Indicates the state of a credit file when a numeric score is not available. Mutually exclusive with `credit_score`.              | Required if credit bureau data is present and `credit_score` is not provided.                                                                                                                                                                                                      | enum:<br />`unestablished`<br />`frozen`                                              |
| credit\_report\_source            | The name of the credit bureau.                                                                                                   | Required if your program's underwriting policy requires credit bureau data on all applications. This will be agreed upon with Lead's Legal team during implementation  Required if any of `credit_pulled_at`, `credit_score`, or `credit_report_non_score_value` are present.      | enum:<br />`equifax`<br />`experian`<br />`transunion`                                |

## 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](https://www.iso.org/iso-8601-date-and-time-format.html) |
| effective\_at | The timestamp of when the related object(s) were polled to collect the information for this record. | Required     | datetime<br />[ISO8601](https://www.iso.org/iso-8601-date-and-time-format.html) |
