An account must be created for all approved applications.
Deposit details are only relevant for deposit products and credit details are only relevant for credit products.
Deposit details are only relevant for deposit products and credit details are only relevant for credit products.
For all optional fields where you do not plan to pass through data, please include the header and an empty value.
IDs & Details
| Field | Description | Required | Data Type |
|---|---|---|---|
| client_account_id | Unique ID of the account | Required | string |
| application_id | Unique ID of the application in your system. | Required if a Credit Balance will be linked to the account. Not required for deposit products. | string |
| account_holder_type | Type of account holder. | Required | enum:consumercommercial |
| account_holders | IDs of any account holders and co-holders. | Required with a min_size of 1 | An array of account holder IDs. Example ”entity_123”, “entity_456” Can be either entity_id or client_customer_id. |
| authorized_signers | A list of authorized signers. These are persons who can access, control, and change products and services on the account. | Required if account_holder_type = commercial and min size >=1 for commercial | An array of authorized signer IDs. Example ”entity_123”, “entity_456” Can be either entity_id or client_customer_id. |
| authorized_users1 | A list of authorized users. These are persons who do not own the account but have restricted, authorized use on the account. Optionally, the Authorized Users file may be used instead if max items > 10. | Optional. May not be used if your program delivers authorized_users in the Authorized Users file. | An array of authorized user IDs. Example ”entity_123”, “entity_456” Can be either entity_id or client_customer_id. |
| currency | Account currency. This signals to Lead which currency you are using to report available_credit and credit_limit in the Accounts file. This may be different currency reported in Balance Daily files if your end-users hold Balances in multiple currencies. 3 letter code, e.g. USD | Required | ISO4217 |
| 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. | Required | boolean |
authorized_usersparameter will no longer be supported on the Accounts file.
Status & Timing
| Field | Description | Required | Data Type |
|---|---|---|---|
| created_at | Datetime account initiated. | Required | datetime ISO8601 |
| status | active: Account is activeinactive: Account with no activityclosed: Account is closed | Required | enum:activeinactiveclosed |
| status_reason | The reason for the decision on the status. | Required | enum:fraudulentclient_closeduser_closedentity_closedfrozendormantactivepaid_offcharged_offother Note user_closed will eventually be deprecated in favor of entity_closed |
& Exception Approval
| Field | Description | Required | Data Type |
|---|---|---|---|
| aan_delivered_at | The datetime the adverse action notice (AAN) was delivered. | Required if status_reason = client_closed | datetime ISO8601 |
| aan_reason | Reason an AAN was sent to the customer. | Required if status_reason = client_closed | string |
| aan_delivery_method | AAN delivery method. | Required if status_reason = client_closed | enum:emailtextother |
Compliance
| Field | Description | Required | Data Type |
|---|---|---|---|
| documents | An array of JSON hashes of customer-facing documents. The JSON hash should reference any dynamic document that has been uploaded to the Documents folder or the version of a static document approved by Lead compliance, and include the document name/type, its client_document_name or document_id, its version, and its consent date. The required docs will be defined between the client and Lead bank during setup. | Required | Example ”document_id”: “client_document_123”, “type”: “esign_agreement”, “consented_at”: “2025-02-12T15:38:34.101-06:00”, “version”: “20220202” Note: JSON strings embedded in CSV fields must be enclosed in double quotes, with internal double quotes escaped by doubling them (""). For documents uploaded via SFTP, please input the full file name as document_id. The suggested naming convention is: `<Date>__<AccountID><FileType><Version>.<FileExtension> |
Credit Details
| Field | Description | Required | Data Type |
|---|---|---|---|
| is_scra | Does the Servicemembers Civil Relief Act (SCRA) apply to this account. | Required if a Credit Balance will be linked to this account. AND status != closed | boolean |
| scra_started_at | The datetime when SCRA starts. | Required if is_scra = true | dateYYYY-MM-DD |
| scra_ended_at | The datetime when SCRA ends. | Optional. Expected if is_scra = trueand the SCRA end date is known. Disallowed if is_scra is false | dateYYYY-MM-DD |
| is_mla | true if the customer is subject to the Military Lending Act (MLA); false otherwise. | Required if a Credit Balance will be linked to the account and status != closed | boolean |
| underwriting_grade | The grade or score assigned to the customer based on underwriting. | Required if a Credit Balance will be linked to the account and status != closed | string |
| available_credit | Available credit limit on the customer’s account. Lead validates that this value equals Credit Limit minus the sum of the balance field for all Balances linked to this account | Required if a Credit Balance will be linked to the account and status != closed | number currency decimal |
| 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 if a Credit Balance will be linked to the account and status != closed | number currency decimal |
| max_credit_limit | The maximum credit limit the customer has been approved for based on original underwriting and the product. | Required if a Credit Balance will be linked to the account and status != closed | number currency decimal |
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 accounts. This will be agreed upon with Lead’s Legal team during implementation Required if any of credit_score or credit_report_source are present | datetime ISO8601 |
| credit_score | Credit score given by the credit bureau. Cannot be above 999. | Required if your program’s underwriting policy requires credit bureau data on all accounts. This will be agreed upon with Lead’s Legal team during implementation Required if any of credit_pulled_at or credit_report_source are present | number |
| credit_report_source | The name of the credit bureau. | Required if your program’s underwriting policy requires credit bureau data on all accounts. This will be agreed upon with Lead’s Legal team during implementation Required if credit_pulled_at or credit_score are present | enum:equifaxexperiantransunion |